/ikyu/hotels/calendar

POST /api/ikyu/hotels/calendar

Price: 1 credit

Get a hotel's availability calendar on Ikyu (一休.com): for each check-in day, whether a stay is bookable for the given nights, adults and rooms, the lowest price, and whether the waitlist is open

How to use it

Hotel ids come from ikyu/hotels/search. Pass an available check_in_date to ikyu/hotels/plans for the plans and rooms of that stay.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• nights integer — Number of nights (default: 1; min: 1; max: 9)
• adults integer — Adults per room (default: 2; min: 1; max: 10)
• rooms integer — Number of rooms (default: 1; min: 1; max: 10)
• hotel string required — Ikyu hotel id or hotel URL (examples: "00001278", "https://www.ikyu.com/00001278/"; minLength: 1)
• date_from integer nullable — First check-in day as unix seconds, day-granular; today when omitted (examples: 1794700800; min: 0)
• count integer required — Number of consecutive days (min: 1; max: 120)

Response

• @type string (default: "IkyuCalendarDay")
• hotel_id string required
• check_in_date integer required
• available boolean required
• lowest_price integer nullable
• waitlist_available boolean nullable

Errors

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