FiveGuys API endpoint
Use Crawlora's Five Guys Directory API to extract supported public FiveGuys data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/fiveguys/directoryReturns 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. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| path | string | No | Optional. Directory path from a previous response's children[].path, e.g. \ | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/fiveguys/directory" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.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"
}
}Request schema
No body schema
Response schema
#/definitions/fiveguys.directoryResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | Code is the HTTP status code or a custom code used to indicate the result of the request @example 200 | |||
| data | fiveguys.DirectoryResponse | No | ||||
| data.children | array | No | ||||
| data.children[].city | string | No | Chicago | City/Region are set only on a store-level child. | ||
| data.children[].geomodifier | string | No | Medical District | Geomodifier is the per-restaurant area/plaza label, set only on a store-level child (e.g. "Medical District"). | ||
| data.children[].is_location | boolean | No | false | IsLocation marks a child that is a restaurant rather than another directory level -- call GET /fiveguys/store with its path. | ||
| data.children[].location_count | integer | No | 38 | LocationCount is how many restaurants sit under this branch, as Yext reports it. Absent at the deepest level, where children are restaurants themselves. | ||
| data.children[].name | string | No | Illinois | Name is the state or city name. Empty on a store-level child, whose name is always the generic brand name -- read Geomodifier there. | ||
| data.children[].path | string | No | il | |||
| data.children[].region | string | No | IL | |||
| data.children[].url | string | No | https://restaurants.fiveguys.com/il | |||
| data.count | integer | No | 34 | |||
| data.fetched_at | string | No | 2026-09-05T12:00:00Z | |||
| data.name | string | No | Illinois | |||
| data.path | string | No | il | |||
| data.source_url | string | No | https://restaurants.fiveguys.com/il | |||
| msg | unknown | No | Msg is the message that describes the result of the request @example "Request successful" |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/fiveguys/directory" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms