/ikyu/hotels

POST /api/ikyu/hotels

Price: 5 credits

Get a hotel or ryokan profile from Ikyu (一休.com): name, type, address, access, coordinates, area, check-in and check-out times, facilities and features, baths, pet and child policy, guest rating with sub-scores, Premium benefits, announcements, guide text, photos and in-house restaurants

How to use it

Hotel ids come from ikyu/hotels/search. Bookable plans with prices are ikyu/hotels/plans and guest reviews are ikyu/hotels/reviews.

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)

Response

• @type string (default: "IkyuHotel")
• id string required
• url string required
• name string nullable
• property_type string nullable
• catchphrase string nullable
• access string nullable
• address string nullable
• prefecture string nullable
• postal_code string nullable
• phone string nullable
• latitude number nullable
• longitude number nullable
• region object nullable
  • @type string (default: "IkyuArea")
  • id string required
  • name string nullable
• area object nullable
  • @type string (default: "IkyuArea")
  • id string required
  • name string nullable
• sub_area object nullable
  • @type string (default: "IkyuArea")
  • id string required
  • name string nullable
• hot_spring_area string nullable
• room_count integer nullable
• check_in_from string nullable
• check_in_until string nullable
• check_out string nullable
• opened_date integer nullable
• pets_allowed boolean nullable
• pets_note string nullable
• children_allowed boolean nullable
• children_note string nullable
• has_spa boolean nullable
• notes string nullable
• baths array (default: [])
  • @type string (default: "IkyuBath")
  • code string nullable
  • name string nullable
  • hot_spring_source string nullable
• fitness object nullable
  • @type string (default: "IkyuFitness")
  • opens_at string nullable
  • closes_at string nullable
  • last_admission string nullable
  • guest_price integer nullable
  • visitor_price integer nullable
• features array (default: [])
  • @type string (default: "IkyuHotelFeature")
  • code string required
  • name string nullable
  • available boolean nullable
• is_premium boolean nullable
• is_ikyu_plus boolean nullable
• premium_since_date integer nullable
• premium_benefits array (default: [])
  • @type string (default: "IkyuPremiumBenefit")
  • content string required
  • note string nullable
• rating object nullable
  • @type string (default: "IkyuHotelRating")
  • average number nullable
  • count integer nullable
  • satisfaction number nullable
  • room number nullable
  • service number nullable
  • bath number nullable
  • facilities number nullable
  • meal number nullable
• area_rank integer nullable
• area_rank_label string nullable
• announcements array (default: [])
  • @type string (default: "IkyuHotelAnnouncement")
  • text string nullable
  • image object nullable
    • @type string (default: "IkyuImage")
    • url string required
    • caption string nullable
    • category string nullable
• guide array (default: [])
  • @type string (default: "IkyuHotelGuideSection")
  • text string nullable
  • images array (default: [])
    • @type string (default: "IkyuImage")
    • url string required
    • caption string nullable
    • category string nullable
• photos array (default: [])
  • @type string (default: "IkyuImage")
  • url string required
  • caption string nullable
  • category string nullable
• restaurants array (default: [])
  • @type string (default: "IkyuHotelRestaurant")
  • id string required
  • url string required
  • name string nullable
  • genre string nullable
  • cuisine string nullable
  • image string nullable
• themes array (default: [])
  • @type string (default: "IkyuTheme")
  • id string required
  • name string nullable
• suggested_questions array (default: [])

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.