/retty/restaurants

POST /api/retty/restaurants

Price: 5 credits

Get a restaurant profile from Retty (retty.me): name, categories, area, address, coordinates, phones, access, opening hours, holidays, budget, cards, smoking, features, review and reaction counts, highlights, photos, the full menu and the bookable courses

How to use it

Restaurant ids come from retty/restaurants/search. Reviews are retty/restaurants/reviews and photos are retty/restaurants/photos.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• restaurant string required — Retty restaurant id or restaurant URL (examples: "100000037961", "https://retty.me/area/PRE13/ARE1/SUB101/100000037961/"; minLength: 1)

Response

• @type string (default: "RettyRestaurant")
• id string required
• url string required
• name string nullable
• name_reading string nullable
• former_name string nullable
• categories array (default: [])
• business_status string nullable
• membership string nullable
• prefecture object nullable
  • @type string (default: "RettyNamedId")
  • id string required
  • name string nullable
• area object nullable
  • @type string (default: "RettyNamedId")
  • id string required
  • name string nullable
• sub_area object nullable
  • @type string (default: "RettyNamedId")
  • id string required
  • name string nullable
• large_categories array (default: [])
  • @type string (default: "RettyNamedId")
  • id string required
  • name string nullable
• detailed_categories array (default: [])
  • @type string (default: "RettyNamedId")
  • id string required
  • name string nullable
• purposes array (default: [])
  • @type string (default: "RettyNamedId")
  • id string required
  • name string nullable
• address string nullable
• postal_code string nullable
• latitude number nullable
• longitude number nullable
• phones array (default: [])
• nearest_station string nullable
• minutes_from_station integer nullable
• access string nullable
• websites array (default: [])
• facebook_url string nullable
• instagram_url string nullable
• twitter_url string nullable
• lunch_budget_min integer nullable
• lunch_budget_max integer nullable
• dinner_budget_min integer nullable
• dinner_budget_max integer nullable
• credit_cards string nullable
• accepted_cards array (default: [])
• smoking string nullable
• smoking_notes array (default: [])
• holidays string nullable
• opening_hours array (default: [])
  • @type string (default: "RettyOpeningPeriod")
  • days array (default: [])
  • opens_at string nullable
  • closes_at string nullable
  • last_order_at string nullable
  • is_always_open boolean nullable
• opening_hours_note string nullable
• remarks string nullable
• reservation_service string nullable
• review_count integer nullable
• lunch_review_count integer nullable
• dinner_review_count integer nullable
• morning_review_count integer nullable
• photo_count integer nullable
• excellent_count integer nullable
• good_count integer nullable
• average_count integer nullable
• been_there_count integer nullable
• want_to_go_count integer nullable
• highlights array (default: [])
  • @type string (default: "RettyTextItem")
  • kind string nullable
  • text string required
• review_summaries array (default: [])
  • @type string (default: "RettyTextItem")
  • kind string nullable
  • text string required
• features array (default: [])
  • @type string (default: "RettyFeature")
  • name string required
  • availability string nullable
  • details array (default: [])
• images array (default: [])
  • @type string (default: "RettyRestaurantImage")
  • url string required
  • caption string nullable
• menu_tax string nullable
• menu array (default: [])
  • @type string (default: "RettyMenuItem")
  • id string required
  • section string required
  • name string nullable
  • price string nullable
  • description string nullable
• courses array (default: [])
  • @type string (default: "RettyCourse")
  • id string required
  • description string nullable
  • dishes string nullable
  • price integer nullable
  • discounted_price integer nullable
  • tax string nullable
  • available_from integer nullable
  • available_to integer nullable
  • bookable_online boolean nullable
  • all_you_can_drink boolean nullable
  • all_you_can_eat boolean nullable
• updated_at integer nullable

Errors

• 422 — restaurant is not a Retty restaurant id or URL 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 — No Retty restaurant under that id 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.