/justeat/restaurants/search

POST /api/justeat/restaurants/search

Price: 20 credits

Find Just Eat (just-eat.co.uk) restaurants and stores delivering to (or collectable from) a UK postcode, with optional filters: service type, cuisines/categories, open now, free delivery, deals, new and minimum rating. Returns cards with name, rating, review count, distance, delivery ETA and cost, cuisines, deals and image.

How to use it

Find Just Eat (just-eat.co.uk) restaurants and grocery stores serving a UK postcode. Provide postcode and count. Optional: service_type (delivery/collection), cuisines (one or more category slugs, they all must match), open_now, free_delivery, has_deals, new_only, min_rating (0-5), sort (recommended/rating/distance/delivery_cost/fastest). Each result has id, name, alias, menu_url, image, address, rating, review_count, cuisines, distance_meters, eta_minutes, delivery_cost, minimum_delivery_value, is_delivery, is_collection, is_open_now_delivery, next_opening_at, deals and flags. Use a result's alias with the restaurants endpoint to get the full menu.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• postcode string required — UK delivery postcode (examples: "EC1A 1BB", "SW1A1AA"; minLength: 1)
• count integer required — Max number of restaurants to return (min: 1)
• service_type string — Delivery or collection (default: "delivery"; one of: "delivery", "collection")
• cuisines array — Filter by cuisine/category (a restaurant must match all selected) (default: []; one of: "deals", "stampcard-restaurants", "halal", "burgers", "chicken", "breakfast", "groceries", "pizza", "indian", "italian", "coffee", "alcohol", "lunch", "asian", "american", "freebies", "kebabs", "sandwiches", "japanese", "chinese", "desserts", "sushi", "curry", "healthy", "convenience", "thai", "pasta", "mediterranean", "turkish", "greek", "mexican", "cafe", "lebanese", "grill", "shops", "korean", "bubble-tea", "noodles", "caribbean", "vietnamese", "fish-and-chips", "middle-eastern", "pharmacy", "burritos", "african", "health-and-beauty", "streetfood", "wraps", "bagels", "bakery", "british", "cakes", "european", "salads", "ethiopian", "bangladeshi", "brunch", "poke", "dinner", "icecream", "malaysian", "smoothies", "electronics", "italianpizza", "jamaican", "peri-peri", "pies", "southamerican", "biryani", "doughnuts", "milkshakes", "nepalese", "pakistani", "seafood", "drinks", "fusion", "hot-dogs", "oriental", "pubfood", "english", "south-indian", "tapas", "waffles", "afghanistani", "authentic-pizza", "bbq", "brazilian-food", "cantonese", "indo-chinese-fusion", "steak", "dim-sum", "glutenfree", "gourmet", "jerk", "pan-asian", "persian", "spanish", "eastern-european", "fastfood", "filipino", "frozenyogurt", "Moroccan", "nigerian", "portuguese", "venezuelan", "argentinian", "crepes", "english-breakfast", "flowers", "french", "ghanaian", "indonesian", "iranian", "latinamerican", "pancakes", "sichuan", "sri-lankan", "allnightalcohol", "beauty", "business-lunch", "columbian", "deli", "german", "gifts", "gourmetburgers", "iraqi", "kurdish", "peruvian", "polish", "roast-dinners", "singapore", "southafrican", "specialty", "syrian", "taiwanese", "ukrainian", "west-african", "meal_deal", "local-legends", "arabic", "baguettes", "balti", "carvery", "continental", "cuban", "egyptian", "georgian", "household", "hungarian", "paninis", "parmesans", "pet-supplies", "picknmix", "punjabi", "romanian", "rotisserie", "scottish", "smoke-house", "soup", "southindian", "subways", "supermarkets", "sweets", "tex-mex", "8off", "favouritespersonalised", "new")
• open_now boolean — Only restaurants open now for the chosen service type (default: false)
• free_delivery boolean — Only restaurants with free delivery (default: false)
• has_deals boolean — Only restaurants with active deals/offers (default: false)
• new_only boolean — Only newly added restaurants (default: false)
• min_rating number nullable — Only restaurants with at least this average rating (min: 0; max: 5)
• sort string — Result ordering (default: "recommended"; one of: "recommended", "rating", "distance", "delivery_cost", "fastest")

Response

• @type string (default: "JusteatSearchRestaurant")
• id string required
• name string nullable
• alias string nullable
• menu_url string nullable
• image string nullable
• address object nullable
  • @type string (default: "JusteatAddress")
  • street string nullable
  • city string nullable
  • postcode string nullable
  • latitude number nullable
  • longitude number nullable
  • country string nullable
• rating number nullable
• review_count integer nullable
• cuisines array (default: [])
• distance_meters number nullable
• eta_minutes number nullable
• eta_lower number nullable
• eta_upper number nullable
• delivery_cost number nullable
• minimum_delivery_value number nullable
• is_delivery boolean (default: false)
• is_collection boolean (default: false)
• is_open_now_delivery boolean (default: false)
• is_open_now_collection boolean (default: false)
• is_open_now_preorder boolean (default: false)
• is_temporarily_offline boolean (default: false)
• is_new boolean (default: false)
• is_premier boolean (default: false)
• next_opening_at string nullable
• deals array (default: [])
  • @type string (default: "JusteatDeal")
  • description string nullable
  • offer_type string nullable

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.