/deliveroo/restaurants

POST /api/deliveroo/restaurants

Price: 20 credits

Get full Deliveroo (deliveroo.co.uk) restaurant details by {city}/{neighborhood}/{slug} (or menu URL): name, address, rating, review count, currency and the complete menu with categories, items, prices, descriptions, images and modifier groups.

How to use it

Fetch a single Deliveroo (deliveroo.co.uk) restaurant by slug '{city}/{neighborhood}/{slug}' (e.g. 'london/soho/bar-bruno') or a full menu URL. Returns id, name, alias, image, description, rating, rating_label, review_count, address (street/neighborhood/city/postcode/country), currency, branch_type, fulfillment_type, menu_id, drn_id, brand_drn_id, category_count, item_count and the full menu as categories, each with items (name, description, price, price_discounted, image, popular, available, is_highly_rated, calories, dietary_tags, allergens, offer_text and modifier_groups with options and option prices).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• restaurant string required — Deliveroo restaurant as {city}/{neighborhood}/{slug} or a full menu URL (examples: "london/soho/bar-bruno", "https://deliveroo.co.uk/menu/london/soho/bar-bruno"; minLength: 1)

Response

• @type string (default: "DeliverooRestaurant")
• id string required
• url string required
• name string nullable
• alias string nullable
• image string nullable
• description string nullable
• rating number nullable
• rating_label string nullable
• review_count integer nullable
• address object nullable
  • @type string (default: "DeliverooRestaurantAddress")
  • street string nullable
  • neighborhood string nullable
  • city string nullable
  • postcode string nullable
  • country string nullable
• city_id integer nullable
• zone_id integer nullable
• currency string nullable
• currency_symbol string nullable
• branch_type string nullable
• fulfillment_type string nullable
• menu_id string nullable
• drn_id string nullable
• brand_drn_id string nullable
• category_count integer (default: 0)
• item_count integer (default: 0)
• categories array (default: [])
  • @type string (default: "DeliverooMenuCategory")
  • id string required
  • name string required
  • items array (default: [])
    • @type string (default: "DeliverooMenuItem")
    • id string required
    • name string required
    • description string nullable
    • price number nullable
    • price_discounted number nullable
    • currency string nullable
    • image string nullable
    • category_id string nullable
    • popular boolean (default: false)
    • available boolean (default: true)
    • is_highly_rated boolean (default: false)
    • calories string nullable
    • dietary_tags array (default: [])
    • allergens string nullable
    • offer_text string nullable
    • modifier_groups 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 — Restaurant not found (well-formed slug but the menu page does not exist) 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.