/jalan/hotels/reviews

POST /api/jalan/hotels/reviews

Price: 5 credits

Get guest reviews for a Jalan (じゃらん) hotel/ryokan by id (or hotel URL): overall rating, per-category scores (room, bath, breakfast, dinner, service, cleanliness), review title and body, post date, reviewer (name, gender, age group), trip type, stay period, booked plan, room and meal type and price range. Reviews are returned most recent first.

How to use it

Fetch guest reviews for a single Jalan (じゃらん) hotel or ryokan by its numeric id (e.g. '340595' or 'yad340595') or a full hotel URL. Each item has id, url, rating (overall, 1-5), title, text (review body), created_at (post date), author (+author_id), gender, age_group, trip_type, stay_period, plan_name, room_type, meal_type, price_range and category_ratings (per-aspect scores). Reviews are ordered most recent first.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• hotel string required — Jalan hotel/ryokan id (numeric, e.g. 340595) or a full hotel URL (examples: "340595", "yad340595", "https://www.jalan.net/yad340595/"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1)

Response

• @type string (default: "JalanReview")
• id string required
• url string required
• rating number nullable
• text string nullable
• created_at string nullable
• author string nullable
• author_id string nullable
• gender string nullable
• age_group string nullable
• trip_type string nullable
• stay_period string nullable
• plan_name string nullable
• room_type string nullable
• meal_type string nullable
• price_range string nullable
• category_ratings object (default: {})
  • * number

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 — Hotel not found (well-formed id but the hotel does not exist on Jalan) 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.