/deliveroo/restaurants/search

POST /api/deliveroo/restaurants/search

Price: 20 credits

Find Deliveroo (deliveroo.co.uk) restaurants and stores delivering to a location (latitude/longitude) with optional filters: free-text keyword, fulfillment method, sort order, cuisines, dietary options, meal deals, top-rated, fast delivery, hygiene rating and Deliveroo's Choice. Returns cards with name, rating, review count, distance, delivery time, offers and image.

How to use it

Find Deliveroo (deliveroo.co.uk) restaurants and grocery stores delivering to a location. Provide latitude and longitude (of the delivery address) and count. Optional: keyword (free-text restaurant or dish name), fulfillment_method (delivery/pickup), sort (recommended/distance/fastest/rating), cuisines (one or more, they stack), dietary (vegan, halal, gluten free, ...), meal_deals, top_rated, under_30_min, hygiene_rating, deliveroo_choice. Each result has id, name, url, image, rating, rating_label, review_count, distance (miles), delivery_time (minutes), is_deliveroo_choice, is_sponsored and offers. Use the restaurant url 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)
• fulfillment_method string — Fulfillment method (default: "DELIVERY"; one of: "DELIVERY", "PICKUP")
• sort string — Sort order (default: "recommended"; one of: "recommended", "distance", "time", "rating")
• cuisines array — Filter by cuisine (multiple cuisines stack) (default: []; one of: "acai", "african", "american", "asian", "bagels", "bakery", "bangladeshi", "bao", "bbq", "biryani", "brazilian", "breakfast", "british", "burgers", "burritos", "cakes", "calzone", "cantonese", "caribbean", "chicken", "chinese", "coffee", "curry", "donuts", "dumplings", "falafel", "filipino", "fish", "focaccia", "french", "gelato", "german", "greek", "grill", "gyros", "healthy", "indian", "indonesian", "italian", "japanese", "juices", "katsu", "kebab", "korean", "lebanese", "malaysian", "mexican", "mezze", "milkshakes", "moroccan", "nepalese", "noodles", "pakistani", "pancakes", "pasta", "pastries", "persian", "peruvian", "pho", "pizza", "poke", "polish", "portuguese", "ramen", "russian", "salads", "sandwiches", "seafood", "shawarma", "sichuan", "soup", "spanish", "steak", "sushi", "tacos", "tapas", "thai", "turkish", "udon", "vietnamese", "waffles", "western", "wings", "wraps")
• dietary array — Filter by dietary options (default: []; one of: "vegetarian", "vegan", "vegan friendly", "halal", "gluten free", "organic")
• meal_deals boolean — Only restaurants with meal deals (default: false)
• top_rated boolean — Only restaurants rated 4.5 stars or higher (default: false)
• under_30_min boolean — Only restaurants delivering in under 30 minutes (default: false)
• hygiene_rating boolean — Only restaurants with a 5 hygiene rating (default: false)
• deliveroo_choice boolean — Only Deliveroo's Choice restaurants (default: false)

Response

• @type string (default: "DeliverooSearchRestaurant")
• id string required
• name string nullable
• url string nullable
• image string nullable
• drn_id string nullable
• branch_type string nullable
• rating number nullable
• rating_label string nullable
• review_count integer nullable
• distance number nullable
• delivery_time integer nullable
• is_deliveroo_choice boolean (default: false)
• is_sponsored boolean (default: false)
• offers array (default: [])

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.