/rakuten_travel/hotels/search

POST /api/rakuten_travel/hotels/search

Price: 10 credits

Search Rakuten Travel (楽天トラベル) hotels/ryokan by Japanese prefecture with sort order. Returns hotel cards with name, image, rating, review count, lowest reference price, access info and amenity features.

How to use it

List Rakuten Travel (楽天トラベル) hotels/ryokan in a Japanese prefecture (romaji, e.g. 'tokyo'). Sort by recommended/price_low/price_high/rating. Each result has id (hotelNo), name, url, image, description, rating+review_count, price+price_with_tax (lowest reference nightly price in JPY), access and features (amenity tags). Use the hotelNo id with the rakuten_travel/hotels endpoint for full details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• prefecture string required — Japanese prefecture (romaji) to list hotels in (one of: "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "niigata", "toyama", "ishikawa", "fukui", "yamanashi", "nagano", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa"; examples: "tokyo", "osaka", "hokkaido")
• count integer required — Max number of results to return (min: 1)
• sort string — Sort order. Default: recommended (default: "recommended"; one of: "recommended", "price_low", "price_high", "rating")

Response

• @type string (default: "RakutenTravelSearchHotel")
• id string required
• name string required
• url string required
• image string nullable
• description string nullable
• rating number nullable
• review_count integer nullable
• price integer nullable
• price_with_tax integer nullable
• currency string (default: "JPY")
• access string nullable
• features array (default: [])

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 — The entity was not found, or a precondition failed 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.