/hostelworld/properties

POST /api/hostelworld/properties

Price: 1 credit

Get full Hostelworld property details by property id (or property URL): name, type (hostel/hotel/B&B), description, editorial overview, what the property is best for, directions, address, city, region, coordinates, distance from city centre, rating breakdown (overall, value, security, location, staff, atmosphere, cleanliness, facilities), review count, facilities by category, policies, sustainability levels, group-booking terms, photos, videos, payment methods, check-in window, cancellation policy (deposit-only, non-refundable and free-cancellation terms), tax and fee details, deposit, Hoscar awards and house rules.

How to use it

Fetch a single Hostelworld property by numeric property id or a property URL. Returns one item with id, url, name, property_type, description, hostelworld_says (editorial overview), directions, house_rules, star_rating, is_new, is_featured, is_promoted, is_hostelworld_recommended, best_for, policies, sustainability_levels, currency, business_number, address, city (id, name, country), region, latitude, longitude, distance_from_center_km, distance_from_center_miles, review_count, rating (overall, value, security, location, staff, atmosphere, cleanliness, facilities), deposit_percentage, max_guests_per_booking, check_in_from, check_in_until, latest_checkout, has_free_cancellation, free_cancellation_days, cancellation_policy (deposit_only, non_refundable, free_cancellation — each with description and days), is_tax_included, taxes (type, amount, is_fixed), is_fee_included, fees (type, amount, is_fixed), group_info (additional_terms, cancellation_terms, group_terms, remainder_due, group_max_pax, group_types, age_ranges), facilities (name, facilities), images, videos, payment_methods and awards (year, place, label, location, key). Live nightly rates and availability are a separate endpoint.

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)

Response

• @type string (default: "HostelworldProperty")
• id string required
• url string nullable
• name string nullable
• property_type string nullable
• description string nullable
• hostelworld_says string nullable
• directions string nullable
• house_rules string nullable
• star_rating integer nullable
• is_new boolean nullable
• is_featured boolean nullable
• is_promoted boolean nullable
• is_hostelworld_recommended boolean nullable
• best_for array (default: [])
• policies array (default: [])
• sustainability_levels array (default: [])
• currency string nullable
• business_number string nullable
• address string nullable
• city object nullable
  • @type string (default: "HostelworldCity")
  • id string nullable
  • name string nullable
  • country string nullable
• region string nullable
• latitude number nullable
• longitude number nullable
• distance_from_center_km number nullable
• distance_from_center_miles number nullable
• review_count integer nullable
• rating object nullable
  • @type string (default: "HostelworldRating")
  • overall integer nullable
  • value integer nullable
  • security integer nullable
  • location integer nullable
  • staff integer nullable
  • atmosphere integer nullable
  • cleanliness integer nullable
  • facilities integer nullable
• deposit_percentage integer nullable
• max_guests_per_booking integer nullable
• check_in_from string nullable
• check_in_until string nullable
• latest_checkout string nullable
• has_free_cancellation boolean nullable
• free_cancellation_days integer nullable
• cancellation_policy object nullable
  • @type string (default: "HostelworldPropertyCancellationPolicy")
  • deposit_only object nullable
    • @type string (default: "HostelworldCancellationSubPolicy")
    • description string nullable
    • days integer nullable
  • non_refundable object nullable
    • @type string (default: "HostelworldCancellationSubPolicy")
    • description string nullable
    • days integer nullable
  • free_cancellation object nullable
    • @type string (default: "HostelworldCancellationSubPolicy")
    • description string nullable
    • days integer nullable
• is_tax_included boolean nullable
• taxes array (default: [])
  • @type string (default: "HostelworldTax")
  • type string nullable
  • amount number nullable
  • is_fixed boolean nullable
• is_fee_included boolean nullable
• fees array (default: [])
  • @type string (default: "HostelworldFee")
  • type string nullable
  • amount number nullable
  • is_fixed boolean nullable
• group_info object nullable
  • @type string (default: "HostelworldGroupInfo")
  • additional_terms string nullable
  • cancellation_terms string nullable
  • group_terms string nullable
  • remainder_due string nullable
  • group_max_pax integer nullable
  • group_types array (default: [])
  • age_ranges array (default: [])
• facilities array (default: [])
  • @type string (default: "HostelworldFacilityCategory")
  • name string required
  • facilities array (default: [])
• images array (default: [])
• videos array (default: [])
• payment_methods array (default: [])
• awards array (default: [])
  • @type string (default: "HostelworldAward")
  • year string nullable
  • place integer nullable
  • label string nullable
  • location string nullable
  • key 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 — Property not found (well-formed but nonexistent 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.