/retty/restaurants/search

POST /api/retty/restaurants/search

Price: 5 credits

Search restaurants on Retty (retty.me) by keyword, prefecture, area, sub-area, category, purpose and amenities: name, catchphrase, categories, area, nearest station, phones, lunch and dinner budget, review and want-to-go counts and photos

How to use it

Area, category and purpose ids appear on retty/restaurants profiles. Pass a returned id to retty/restaurants for the full profile and menu.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Free-text keyword (examples: "ラーメン"; minLength: 1)
• prefecture_codes array nullable — Prefecture codes, 01 Hokkaido to 47 Okinawa (examples: ["13"], ["13","14"])
• area_ids array nullable — Retty area ids, as in area.id of retty/restaurants (examples: [1])
• sub_area_ids array nullable — Retty sub-area ids, as in sub_area.id of retty/restaurants (examples: [101])
• category_id integer nullable — Retty category id, as in detailed_categories of retty/restaurants (examples: 350)
• large_category_id integer nullable — Retty large category id, as in large_categories of retty/restaurants (examples: 1)
• purpose_id integer nullable — Retty purpose id, as in purposes of retty/restaurants (examples: 44)
• private_room boolean nullable — Only restaurants with private rooms
• counter_seats boolean nullable — Only restaurants with counter seats
• all_you_can_drink boolean nullable — Only restaurants with all-you-can-drink
• all_you_can_eat boolean nullable — Only restaurants with all-you-can-eat
• credit_cards boolean nullable — Only restaurants accepting credit cards
• paypay boolean nullable — Only restaurants accepting PayPay
• coupons boolean nullable — Only restaurants offering coupons
• online_booking boolean nullable — Only restaurants bookable online
• smoking string nullable — Smoking policy (one of: "smoking", "no_smoking")
• sort string — Result order (default: "recommended"; one of: "recommended", "keyword_match")
• count integer required — Max number of results (min: 1; max: 3000)

Response

• @type string (default: "RettyRestaurantCard")
• id string required
• url string required
• name string nullable
• catchphrase string nullable
• categories array (default: [])
• 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
• nearest_station string nullable
• minutes_from_station integer nullable
• access string nullable
• phones array (default: [])
• lunch_budget_min integer nullable
• lunch_budget_max integer nullable
• dinner_budget_min integer nullable
• dinner_budget_max integer nullable
• review_count integer nullable
• want_to_go_count integer nullable
• reservation_service string nullable
• image_urls 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 — Retty rejected this combination of search filters 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.