/ikyu/restaurants/availability

POST /api/ikyu/restaurants/availability

Price: 5 credits

Get a restaurant's reservation calendar on Ikyu (一休.com レストラン): for each day and meal period, whether it can be booked, the party sizes that can be booked, and whether a last-minute deal applies

How to use it

Restaurant ids come from ikyu/restaurants/search. Pass a reservable visit_date to ikyu/restaurants/times for the bookable times of day.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• restaurant string required — Ikyu restaurant id or restaurant URL (examples: "103903", "https://restaurant.ikyu.com/103903"; minLength: 1)
• date_from integer nullable — First visit day as unix seconds, day-granular; today when omitted (examples: 1791072000; min: 0)
• days integer — Number of consecutive days (default: 30; min: 1; max: 120)
• count integer required — Max number of results (min: 1; max: 480)

Response

• @type string (default: "IkyuRestaurantDay")
• restaurant_id string required
• restaurant_url string required
• visit_date integer required
• meal_period string nullable
• day_of_week string nullable
• is_holiday boolean nullable
• reservable boolean nullable
• party_sizes array (default: [])
• has_closed_inventory boolean nullable
• has_last_minute_deal boolean nullable

Errors

• 422 — restaurant is not an Ikyu 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 Ikyu 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.