Endpoint Playground

Try the Five Guys Directory API

Test Crawlora's Five Guys Directory API with realistic prefilled parameters. Generate a cURL request, inspect the expected structured JSON response, and open the full docs or pricing page when you are ready to integrate this public web data extraction endpoint into your application.

Endpoint facts

Method: GET
API path: /fiveguys/directory
Platform: FiveGuys
Auth: apiKey
Credits: 1 credit/request
Required params: None
Common optional params: path

Five Guys Directory API documentation Five Guys platform page Crawlora API pricing Try Five Guys FAQ API Try Five Guys FAQ Categories API Try Five Guys Menu API Try Five Guys Nearby API Try Five Guys Nutrition Guide API

Prefilled cURL

curl "https://api.crawlora.net/api/v1/fiveguys/directory" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
path	string	No		Optional. Directory path from a previous response's children[].path, e.g. \

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "path": "il",
    "name": "Illinois",
    "children": [
      {
        "name": "Chicago",
        "path": "il/chicago",
        "url": "https://restaurants.fiveguys.com/il/chicago",
        "location_count": 5,
        "is_location": false
      },
      {
        "name": "Peoria",
        "path": "il/peoria",
        "url": "https://restaurants.fiveguys.com/il/peoria",
        "location_count": 1,
        "is_location": false
      }
    ],
    "count": 2,
    "source_url": "https://restaurants.fiveguys.com/il",
    "fetched_at": "2026-09-05T04:00:00Z"
  }
}

Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

1 shown

Group

Method

Auth

Endpoint

GETapiKey1 credit/requestfiveguys.directoryResponseDocFiveGuys

GET /fiveguys/directory

Browse the Five Guys restaurant directory by state and city

Returns one level of Five Guys' US restaurant directory: the 50 states at the root, one state's cities when path is a state (e.g. `il`), and that city's restaurants when path is a city (e.g. `il/chicago`). Each child carries the path to pass back as this endpoint's `path`, and a `location_count` of how many restaurants sit under it. At the deepest level children are restaurants themselves (`is_location` true) -- pass their path to GET /fiveguys/store for the full profile. Use this to enumerate or browse locations; use GET /fiveguys/search or /fiveguys/nearby to find them by query or coordinate instead.

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "path": "il",
    "name": "Illinois",
    "children": [
      {
        "name": "Chicago",
        "path": "il/chicago",
        "url": "https://restaurants.fiveguys.com/il/chicago",
        "location_count": 5,
        "is_location": false
      },
      {
        "name": "Peoria",
        "path": "il/peoria",
        "url": "https://restaurants.fiveguys.com/il/peoria",
        "location_count": 1,
        "is_location": false
      }
    ],
    "count": 2,
    "source_url": "https://restaurants.fiveguys.com/il",
    "fetched_at": "2026-09-05T04:00:00Z"
  }
}

Endpoint details

Method: GET
Path: /fiveguys/directory
Authentication: apiKey
Credit cost: 1 credit/request
Platform: FiveGuys
Parameters: 2 documented fields

Request parameters

path:queryx-api-key:header

Response schema fields

codedatadata.childrendata.children[].citydata.children[].geomodifierdata.children[].is_locationdata.children[].location_countdata.children[].namedata.children[].pathdata.children[].regiondata.children[].urldata.count

Sample response summary

{
  "code": 200,
  "msg": "OK",
  "data": {
    "path": "il",
    "name": "Illinois",
    "children": [
      {
        "name": "Chicago",
        "path": "il/chicago",
        "url": "https://restaurants.fiveguys.com/il/chicago",
        "location_count": 5,
        "is_location": false
      },
      {
        "name": "Peoria",
        "path": "il/peoria",
        "url": "https://restaurants.fiveguys.com/il/peoria",
        "location_count": 1,
        "is_location": false
      }
    ],
    "count": 2,
    "source_url": "https://restaurants.fiveguys.com/il",
    "fetched_at": "2026-09-05T04:00:00Z"
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/fiveguys/directory" \
  -H "x-api-key: $CRAWLORA_API_KEY"

View endpoint docs Open platform page Browse all endpoints Pricing List Five Guys' published customer FAQ List Five Guys FAQ categories List Five Guys menu categories and items Find Five Guys restaurants near a coordinate Get the current Five Guys nutrition & allergen PDF guide's location

Endpoint Playground

Try the Five Guys Directory API

Endpoint facts

Method: GET
API path: /fiveguys/directory
Platform: FiveGuys
Auth: apiKey
Credits: 1 credit/request
Required params: None
Common optional params: path

Prefilled cURL

curl "https://api.crawlora.net/api/v1/fiveguys/directory" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Request parameters visible to crawlers

Parameter	Type	Required	Prefilled value	Description
path	string	No		Optional. Directory path from a previous response's children[].path, e.g. \

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "path": "il",
    "name": "Illinois",
    "children": [
      {
        "name": "Chicago",
        "path": "il/chicago",
        "url": "https://restaurants.fiveguys.com/il/chicago",
        "location_count": 5,
        "is_location": false
      },
      {
        "name": "Peoria",
        "path": "il/peoria",
        "url": "https://restaurants.fiveguys.com/il/peoria",
        "location_count": 1,
        "is_location": false
      }
    ],
    "count": 2,
    "source_url": "https://restaurants.fiveguys.com/il",
    "fetched_at": "2026-09-05T04:00:00Z"
  }
}

Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Endpoint

Choose one catalog endpoint for this request.

1 shown

Group

Method

Auth

Endpoint

GETapiKey1 credit/requestfiveguys.directoryResponseDocFiveGuys

GET /fiveguys/directory

Browse the Five Guys restaurant directory by state and city

API key required. Paste a full key or rotate one from the API Keys page.

Set up API key

View docs

API key

API key required for live requests. Your key is only used to send requests from this Playground.

not configured

Active Playground key: not configured

Manage API keys in Console

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "OK",
  "data": {
    "path": "il",
    "name": "Illinois",
    "children": [
      {
        "name": "Chicago",
        "path": "il/chicago",
        "url": "https://restaurants.fiveguys.com/il/chicago",
        "location_count": 5,
        "is_location": false
      },
      {
        "name": "Peoria",
        "path": "il/peoria",
        "url": "https://restaurants.fiveguys.com/il/peoria",
        "location_count": 1,
        "is_location": false
      }
    ],
    "count": 2,
    "source_url": "https://restaurants.fiveguys.com/il",
    "fetched_at": "2026-09-05T04:00:00Z"
  }
}

Endpoint details

Method: GET
Path: /fiveguys/directory
Authentication: apiKey
Credit cost: 1 credit/request
Platform: FiveGuys
Parameters: 2 documented fields

Request parameters

path:queryx-api-key:header

Response schema fields

Sample response summary

{
  "code": 200,
  "msg": "OK",
  "data": {
    "path": "il",
    "name": "Illinois",
    "children": [
      {
        "name": "Chicago",
        "path": "il/chicago",
        "url": "https://restaurants.fiveguys.com/il/chicago",
        "location_count": 5,
        "is_location": false
      },
      {
        "name": "Peoria",
        "path": "il/peoria",
        "url": "https://restaurants.fiveguys.com/il/peoria",
        "location_count": 1,
        "is_location": false
      }
    ],
    "count": 2,
    "source_url": "https://restaurants.fiveguys.com/il",
    "fetched_at": "2026-09-05T04:00:00Z"
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/fiveguys/directory" \
  -H "x-api-key: $CRAWLORA_API_KEY"