/opentable/restaurants/search

POST /api/opentable/restaurants/search

Price: 10 credits

Search OpenTable restaurants around a location (city, metro, neighborhood or landmark). Returns top restaurants with name, cuisines, price band, overall rating, neighborhood and a representative diner review with per-dimension ratings (food, service, ambience, value).

How to use it

Search OpenTable restaurants near a location given as free text (e.g. 'New York', 'Miami Beach', 'Lincoln Park Chicago'). Each result has id, url, alias, name, metro, macro, neighborhood, price_band (1-4), currency, primary_cuisine, cuisines, rating (overall), image and top_review (text, rating_overall/food/service/ambience/value, dined_at, reviewer).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — Location to search around: city, metro area, neighborhood or landmark name (examples: "New York", "Chicago", "Miami Beach"; minLength: 1)
• count integer required — Max number of restaurants to return (min: 1)

Response

• @type string (default: "OpentableRestaurant")
• id integer required
• url string required
• alias string nullable
• name string required
• metro string nullable
• macro string nullable
• neighborhood string nullable
• price_band integer nullable
• currency string nullable
• primary_cuisine string nullable
• cuisines array (default: [])
• rating number nullable
• image string nullable
• top_review object nullable
  • @type string (default: "OpentableTopReview")
  • id string required
  • text string nullable
  • rating_overall integer nullable
  • rating_food integer nullable
  • rating_service integer nullable
  • rating_ambience integer nullable
  • rating_value integer nullable
  • dined_at string nullable
  • tags array (default: [])
  • photos array (default: [])
  • reviewer object nullable
    • @type string (default: "OpentableReviewer")
    • nickname string nullable
    • initials string nullable
    • is_vip boolean nullable
    • metro string nullable
    • review_count integer nullable
    • image 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 — Location could not be resolved or no restaurants were found 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.