/hostelworld/properties/availability

POST /api/hostelworld/properties/availability

Price: 1 credit

Get live room availability and nightly prices for a Hostelworld property over a date range: dorm and private rooms with per-room type, capacity, ensuite, beds and rooms available, lowest price per night, rate plans (deposit/non-refundable) with average and total price plus a night-by-night price breakdown, lowest dorm and private prices, deposit, free-cancellation policy and cancellation terms.

How to use it

Fetch live availability and nightly rates for a single Hostelworld property (by numeric property id or property URL) for a given check-in/check-out date range and guest count. Returns one item with property_id, url, checkin, checkout, nights, guests, currency, is_available, deposit_percentage, has_free_cancellation, free_cancellation_until, lowest_price_per_night, lowest_dorm_price_per_night, lowest_private_price_per_night, lowest_average_price_per_night, lowest_average_dorm_price_per_night, lowest_average_private_price_per_night, promotions (id, type, name, discount, stack), cancellation_policies (label, description) and rooms. Each room has id, name, room_type, extended_type, is_private, description, label_description, capacity, is_ensuite, grade, is_available, total_beds_available, total_rooms_available, guests_per_room, price_per_night, images and rate_plans (id, payment_type, payment_label, is_default, rate_plan_type, average_price_per_night, total_price, nightly_prices with date and price). Prices are date-dependent and change over time. Use the properties endpoint for static property details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — Hostelworld property id or a property URL containing it (examples: "39493", "https://www.hostelworld.com/hostels/p/39493/onefam-waterloo/"; minLength: 1)
• checkin string required — Check-in date in YYYY-MM-DD format (examples: "2026-08-10")
• checkout string required — Check-out date in YYYY-MM-DD format (examples: "2026-08-13")
• guests integer — Number of guests (default: 1; min: 1; max: 8)

Response

• @type string (default: "HostelworldAvailability")
• property_id string required
• url string nullable
• checkin string required
• checkout string required
• nights integer required
• guests integer required
• currency string nullable
• is_available boolean nullable
• deposit_percentage integer nullable
• has_free_cancellation boolean nullable
• free_cancellation_until string nullable
• lowest_price_per_night number nullable
• lowest_dorm_price_per_night number nullable
• lowest_private_price_per_night number nullable
• lowest_average_price_per_night number nullable
• lowest_average_dorm_price_per_night number nullable
• lowest_average_private_price_per_night number nullable
• promotions array (default: [])
  • @type string (default: "HostelworldPromotion")
  • id string required
  • type string nullable
  • name string nullable
  • discount number nullable
  • stack boolean nullable
• cancellation_policies array (default: [])
  • @type string (default: "HostelworldCancellationPolicy")
  • label string nullable
  • description string nullable
• rooms array (default: [])
  • @type string (default: "HostelworldRoom")
  • id string required
  • name string nullable
  • room_type string nullable
  • extended_type string nullable
  • is_private boolean nullable
  • description string nullable
  • label_description string nullable
  • capacity integer nullable
  • is_ensuite boolean nullable
  • grade string nullable
  • is_available boolean nullable
  • total_beds_available integer nullable
  • total_rooms_available integer nullable
  • guests_per_room integer nullable
  • price_per_night number nullable
  • images array (default: [])
  • rate_plans array (default: [])
    • @type string (default: "HostelworldRatePlan")
    • id string required
    • payment_type string nullable
    • payment_label string nullable
    • is_default boolean nullable
    • rate_plan_type string nullable
    • average_price_per_night number nullable
    • total_price number nullable
    • nightly_prices 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 — Property not found (well-formed but nonexistent or inactive property 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.