Grubhub

Check ordering availability for a batch of Grubhub restaurants

Returns current ordering state for up to 20 restaurants in one call, relative to a diner location. Each entry reports whether the restaurant is open overall and per channel (these can differ), whether delivery and pickup are offered at all as distinct from open right now, whether it delivers to the supplied coordinate, blackout and overloaded flags, distance, delivery and pickup time estimates, delivery fee, order minimum, cuisines, and the next time an order can be sent per channel -- useful when a restaurant is currently closed. The response echoes the requested ids so a caller can tell which ones Grubhub returned nothing for.

get/grubhub/availability

Request

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

Query parameters

restaurant_idsstring required

Comma-separated Grubhub restaurant ids, up to 20

latitudenumber required

Diner location latitude -- availability is relative to it

longitudenumber required

Diner location longitude

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": 2,
    "restaurants": [
      {
        "available_for_delivery": true,
        "available_for_pickup": true,
        "delivers_to_location": true,
        "delivery_estimate_minutes": 25,
        "delivery_fee": {
          "amount": 399,
          "currency": "USD",
          "value": 3.99
        },
        "distance_miles": 0.23,
        "order_minimum": {
          "amount": 399,
          "currency": "USD",
          "value": 3.99
        },
        "pickup_estimate_minutes": 10,
        "restaurant_id": "6238960"
      }
    ]
  }
}

Changes

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