/grubhub/restaurants/search

POST /api/grubhub/restaurants/search

Price: 20 credits

Find Grubhub (grubhub.com) restaurants delivering to or available for pickup at a location (latitude/longitude) with optional filters: free-text keyword, fulfillment method, sort order, cuisines, price tier, rating, delivery time, offers, lowest fees, Grubhub+, open now, new, national brands, alcohol, order tracking and shared cart. Returns cards with name, rating, price tier, delivery fee, minimum, delivery time, distance and image.

How to use it

Find Grubhub (grubhub.com) restaurants near a location. Provide latitude and longitude (of the delivery address) and count. Optional: keyword (free-text restaurant or dish name), order_method (delivery/pickup), sort (recommended/distance/fastest/rating/price_low/price_high), cuisines (one or more, they stack), price_max (1-4 dollar tier), top_rated (4 stars and up), under_30_min, offers, free_delivery, grubhub_plus, open_now, new_only, national_brands, alcohol, order_tracking, shared_cart. Each result has id, name, url, brand_name, chain_name, image, cuisines, rating, rating_count, price_rating, coupon_count, delivery_fee, delivery_minimum, delivery_time (+min/max minutes), distance (miles), open, delivery, pickup and is_new. Use the restaurant id with the restaurants endpoint for the full menu.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• latitude number required — Delivery location latitude (min: -90; max: 90)
• longitude number required — Delivery location longitude (min: -180; max: 180)
• count integer required — Max number of restaurants to return (min: 1)
• keyword string nullable — Free-text search keyword (restaurant or dish name)
• order_method string — Fulfillment method (default: "delivery"; one of: "delivery", "pickup")
• sort string — Sort order (default: "recommended"; one of: "recommended", "distance", "fastest", "rating", "price_low", "price_high")
• cuisines array — Filter by cuisine (multiple cuisines stack) (default: []; one of: "Alcohol", "American", "Asian", "BBQ", "Bagels", "Bakery", "Bodegas", "Bubble Tea", "Burgers", "Chicken", "Chinese", "Coffee", "Dessert", "Fast Food", "Gluten-Free", "Hawaiian", "Healthy", "Indian", "Italian", "Japanese", "Kids Menu", "Korean", "Local Gems", "Mediterranean", "Mexican", "Noodles", "Pizza", "Sandwiches", "Seafood", "Shakes", "Smoothies", "Soup", "Steak", "Sushi", "Thai", "Vegan", "Vegetarian", "Vietnamese")
• price_max integer nullable — Only restaurants at or below this dollar price tier (1-4) (min: 1; max: 4)
• top_rated boolean — Only restaurants rated 4 stars and up (default: false)
• under_30_min boolean — Only restaurants delivering in 30 minutes or less (default: false)
• offers boolean — Only restaurants with offers (default: false)
• free_delivery boolean — Only restaurants with the lowest delivery fees (default: false)
• grubhub_plus boolean — Only Grubhub+ eligible restaurants (default: false)
• open_now boolean — Only restaurants open now (default: false)
• new_only boolean — Only restaurants new to Grubhub (default: false)
• national_brands boolean — Only national brand / chain restaurants (default: false)
• alcohol boolean — Only alcohol stores (default: false)
• order_tracking boolean — Only restaurants with order tracking (default: false)
• shared_cart boolean — Only restaurants supporting group / shared carts (default: false)

Response

• @type string (default: "GrubhubSearchRestaurant")
• id string required
• name string nullable
• url string nullable
• alias string nullable
• brand_name string nullable
• chain_name string nullable
• image string nullable
• cuisines array (default: [])
• rating number nullable
• rating_count integer nullable
• price_rating integer nullable
• coupon_count integer (default: 0)
• delivery_fee number nullable
• delivery_minimum number nullable
• delivery_time integer nullable
• delivery_time_min integer nullable
• delivery_time_max integer nullable
• distance number nullable
• open boolean (default: false)
• delivery boolean (default: false)
• pickup boolean (default: false)
• is_new boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.