FiveGuys

Search Five Guys restaurants by free-text location

Returns Five Guys restaurants matching a free-text location query -- a city, a zip/postal code, a street address, or a landmark -- the same way restaurants.fiveguys.com's own locator search box works. Yext's own query understanding geocodes the text server-side, so no separate geocoding call is needed. Each result carries a full profile: a short area/plaza label distinguishing it from other locations, address, phone, weekly in-store hours plus a separate delivery-hours schedule when published, price tier, restaurant-amenity labels (e.g. Takeout, Dine In, Curbside), pickup/delivery service labels, order/delivery/menu URLs, a Google Place id, and distance in miles/kilometers from the resolved query location. total_results reports how many restaurants matched overall, usually more than one page; use offset to page. A query that resolves to nowhere Five Guys operates returns an empty list rather than an error.

get/fiveguys/search

Request

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

Query parameters

querystring required

Free-text location: a city, a zip/postal code, a street address, or a landmark

limitinteger

Maximum restaurants to return, 1-50 (default 10)

offsetinteger

Result offset for paging through total_results (default 0)

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": {
    "count": 10,
    "locations": [
      {
        "address": {
          "city": "Chicago",
          "country": "US",
          "line1": "180 N Michigan Ave",
          "postal_code": "60601",
          "region": "IL"
        },
        "delivery_hours": {
          "friday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "monday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "saturday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "sunday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "thursday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "tuesday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "wednesday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          }
        },
        "distance_kilometers": 0.74,
        "distance_miles": 0.46,
        "geomodifier": "Michigan Ave",
        "google_place_id": "ChIJHTEJ8EgtDogRepA4KPyvUCU",
        "hours": {
          "friday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "monday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "saturday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "sunday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "thursday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "tuesday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          },
          "wednesday": {
            "open_intervals": [
              {
                "end": "23:00",
                "start": "10:00"
              }
            ]
          }
        },
        "id": "4020",
        "latitude": 41.885572,
        "longitude": -87.624864,
        "name": "Five Guys",
        "path": "180-n-michigan-ave",
        "phone": "+13122919686",
        "price_range": "$",
        "timezone": "America/Chicago",
        "website_url": "https://restaurants.fiveguys.com/180-n-michigan-ave"
      }
    ],
    "query": "Chicago, IL",
    "total_results": 18
  }
}

Changes

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