Dunkin API endpoint
Returns one level of Dunkin's store directory tree. Omit path for the root, which lists every US state Dunkin operates in; pass a state's path (e.g. "ny") to list its cities, or a state/city path (e.g. "ny/new-york") to list its stores. Each child carries its name, path, URL and how many stores sit under that branch. A child with is_store true is a store rather than another directory level -- pass its path (a store id) to GET /dunkin/store. This is a directory browse, not a proximity search: use GET /dunkin/nearby for a radius lookup.
/dunkin/directoryThis is a directory browse, not a proximity search — use /api/v1/dunkin/nearby for a radius lookup.
Query parameters:
path (optional) — directory path from a previous response's children[].path: a state code (e.g. ny) or state/city (e.g. ny/new-york). Omit for the root state index.Response includes path, name, children[], count, source_url, and fetched_at. Each child has name, path, url, store_count (how many stores sit under that branch), and is_store.
| Field | Filled in, of 140 checked | Values in the sample |
|---|---|---|
| name | 140 | “Aberdeen” and 139 other values |
| path | 140 | “md/aberdeen” and 139 other values |
| url | 140 | dunkindonuts.com |
| store_count | 140 | 1 to 48, median 1 |
| is_store | 140 | true in 0 of 140 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| path | string | No | Directory path from a previous response's children[].path: a state code (e.g. \ | ny | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/dunkin/directory" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"path": "",
"name": "United States",
"children": [
{
"name": "New York",
"path": "ny",
"url": "https://www.dunkindonuts.com/locations/us/ny/",
"store_count": 598,
"is_store": false
}
],
"count": 48,
"source_url": "https://cdn.yextapis.com/v2/accounts/me/entities",
"fetched_at": "2026-09-02T17:10:00Z"
}
}Request schema
No body schema
Response schema
#/definitions/dunkin.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 | dunkin.DirectoryResponse | No | ||||
| data.children | array | No | ||||
| data.children[].is_store | boolean | No | false | IsStore marks a child that is a store rather than another directory level -- call /dunkin/store with its path. | ||
| data.children[].name | string | No | New York | |||
| data.children[].path | string | No | ny | |||
| data.children[].store_count | integer | No | 390 | StoreCount is how many stores sit under this branch. Absent on the deepest level, where children are stores themselves. | ||
| data.children[].url | string | No | ||||
| data.count | integer | No | 58 | |||
| data.fetched_at | string | No | ||||
| data.name | string | No | ||||
| data.path | string | No | ny | |||
| data.source_url | string | No | ||||
| msg | unknown | No | Msg is the message that describes the result of the request @example "Request successful" |
| 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 |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/dunkin/directory" \
-H "x-api-key: $CRAWLORA_API_KEY"