/rakuten_travel/hotels/reviews

POST /api/rakuten_travel/hotels/reviews

Price: 1 credit

Get Rakuten Travel (楽天トラベル) hotel/ryokan guest reviews by hotelNo (or hotel URL): overall rating, title, text, post date, per-category scores, review images, reviewer profile (nickname, gender, age range, trip purpose and companion) and stay details (check-in date, plan and room name).

How to use it

Get guest reviews of a Rakuten Travel (楽天トラベル) hotel/ryokan by numeric hotelNo (e.g. '28576') or a full hotel URL. Returns each review with rating (1-5), title, text, created_at, per-category scores (room, hospitality, location, breakfast, dinner, bath, facility, cleanliness), images and reviewer details (author nickname, gender, age range, trip purpose, companion) plus check-in date, plan and room name.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• hotel string required — Rakuten Travel hotel as a numeric hotelNo or a full hotel URL (examples: "28576", "https://travel.rakuten.co.jp/HOTEL/28576/28576.html"; minLength: 1)
• count integer required — Max number of reviews to return (min: 1)

Response

• @type string (default: "RakutenTravelHotelReview")
• id string required
• text string nullable
• rating integer nullable
• view_count integer nullable
• like_count integer nullable
• created_at string nullable
• is_anonymous boolean nullable
• author string nullable
• author_gender string nullable
• author_age_range integer nullable
• author_review_count integer nullable
• travel_purpose string nullable
• travel_companion string nullable
• check_in_date string nullable
• plan_name string nullable
• room_name string nullable
• images array (default: [])
• scores array (default: [])
  • @type string (default: "RakutenTravelHotelReviewScore")
  • code string required
  • score integer required
• replies array (default: [])
  • @type string (default: "RakutenTravelHotelReviewReply")
  • id string required
  • author string nullable
  • text string nullable
  • created_at string nullable

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 hotelNo but the hotel does not exist) 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.