Sonic API endpoint
Use Crawlora's Sonic Drive-In Directory API to extract supported public Sonic 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.
/sonic/directoryReturns Sonic Drive-In's restaurant directory as a country to state to city tree, with a restaurant count at every level. Use it to discover which states and cities have restaurants before calling GET /sonic/locations or GET /sonic/nearby. Each city carries both its display name and the slug that composes into a store path. Counts here describe listed restaurants and are internally consistent (the city counts sum to total_count); GET /sonic/locations enumerates a larger set of store pages, so the two totals intentionally differ. 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 |
|---|---|---|---|---|---|
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/sonic/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 |
|---|---|---|
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"total_count": 3364,
"countries": [
{
"country_code": "US",
"country_name": "United States",
"count": 3364,
"states": [
{
"code": "AL",
"name": "Alabama",
"count": 95,
"cities": [
{
"name": "Albertville",
"slug": "albertville",
"count": 1
}
]
},
{
"code": "WY",
"name": "Wyoming",
"count": 6,
"cities": [
{
"name": "Cheyenne",
"slug": "cheyenne",
"count": 2
}
]
}
]
}
],
"source_url": "https://api-idp.sonicdrivein.com/snc/web-exp-api/v1/location/list/details",
"fetched_at": "2026-09-06T12:00:00Z"
}
}Request schema
No body schema
Response schema
#/definitions/sonic.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 | sonic.DirectoryResponse | No | ||||
| data.countries | array | No | ||||
| data.countries[].count | integer | No | 3364 | |||
| data.countries[].country_code | string | No | US | |||
| data.countries[].country_name | string | No | United States | |||
| data.countries[].states | array | No | ||||
| data.countries[].states[].cities | array | No | ||||
| data.countries[].states[].cities[].count | integer | No | 1 | |||
| data.countries[].states[].cities[].name | string | No | Albertville | |||
| data.countries[].states[].cities[].slug | string | No | albertville | Slug is the city segment as it appears in a store path, which is the lowercased form GET /sonic/locations returns. | ||
| data.countries[].states[].code | string | No | AL | |||
| data.countries[].states[].count | integer | No | 95 | |||
| data.countries[].states[].name | string | No | Alabama | |||
| data.fetched_at | string | No | ||||
| data.source_url | string | No | ||||
| data.total_count | integer | No | 3364 | |||
| 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/sonic/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