---
title: "Browse the Five Guys restaurant directory by state and city"
method: GET
path: "/fiveguys/directory"
tags: ["FiveGuys"]
---

# Browse the Five Guys restaurant directory by state and city

`GET /fiveguys/directory`

## Request

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

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.

## Query parameters

- `path` string

## Headers

- `x-api-key` string, required

## Response `200`

OK

- FiveguysDirectoryResponseDoc
  - `code` integer: Code is the HTTP status code or a custom code used to indicate the result of the request @example 200
  - `data` FiveguysDirectoryResponse
    - `children` FiveguysDirectoryChild[]
      - `city` string: City/Region are set only on a store-level child.
      - `geomodifier` string: Geomodifier is the per-restaurant area/plaza label, set only on a store-level child (e.g. "Medical District").
      - `is_location` boolean: IsLocation marks a child that is a restaurant rather than another directory level -- call GET /fiveguys/store with its path.
      - `location_count` integer: LocationCount is how many restaurants sit under this branch, as Yext reports it. Absent at the deepest level, where children are restaurants themselves.
      - `name` string: Name is the state or city name. Empty on a store-level child, whose name is always the generic brand name -- read Geomodifier there.
      - `path` string
      - `region` string
      - `url` string
    - `count` integer
    - `fetched_at` string
    - `name` string
    - `path` string
    - `source_url` string
  - `msg` unknown

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)