/ikyu/hotels/reviews

POST /api/ikyu/hotels/reviews

Price: 5 credits

Get guest reviews of a hotel on Ikyu (一休.com): title, text, overall and sub-ratings for room, service, bath, facilities and meals, stay date, room, party size, meal plan, the hotel's reply and photos

How to use it

Hotel ids come from ikyu/hotels/search. ikyu/hotels carries the hotel's rating and review count.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• hotel string required — Ikyu hotel id or hotel URL (examples: "00001278", "https://www.ikyu.com/00001278/"; minLength: 1)
• sort string — Result order (default: "newest"; one of: "newest", "recommended", "highest_rated", "lowest_rated")
• count integer required — Max number of results (min: 1; max: 10000)

Response

• @type string (default: "IkyuHotelReview")
• id string required
• hotel_id string required
• hotel_url string required
• text string nullable
• rating number nullable
• satisfaction_rating number nullable
• room_rating number nullable
• service_rating number nullable
• bath_rating number nullable
• facilities_rating number nullable
• meal_rating number nullable
• author_name string nullable
• author_hash string nullable
• is_member boolean nullable
• created_at integer nullable
• stay_date integer nullable
• room_name string nullable
• rooms integer nullable
• guests integer nullable
• meal_code string nullable
• meal_name string nullable
• like_count integer nullable
• hotel_reply string nullable
• images array (default: [])
  • @type string (default: "IkyuImage")
  • url string required
  • caption string nullable
  • category string 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.