Dunkin

Browse the Dunkin store directory

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.

get/dunkin/directory

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/dunkin/directory
  • Auth: API key in header x-api-key

Query parameters

pathstring

Directory path from a previous response's children[].path: a state code (e.g. \

Headers

x-api-keystring required

API key required

Response

OK

codeinteger

Code is the HTTP status code or a custom code used to indicate the result of the request @example 200

msgunknown

Example response

{
  "data": {
    "children": [
      {
        "name": "New York",
        "path": "ny",
        "store_count": 390
      }
    ],
    "count": 58,
    "path": "ny"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.