/hostelworld/properties/search

POST /api/hostelworld/properties/search

Price: 10 credits

Search Hostelworld properties (hostels, hotels, B&Bs) in a city. Returns property cards with name, type, description, address, district, city, coordinates, distance from the city centre, star rating, guest rating breakdown, review count, facilities by category, photos and the lowest nightly prices. Provide a check-in date to get live nightly prices.

How to use it

Search Hostelworld properties in a city. city is a city name or a numeric Hostelworld city id ('London', 'Bangkok', '3'); check_in (YYYY-MM-DD), nights, guests and currency drive live nightly prices (omit check_in for listings without prices). Each result has id, url, name, property_type (HOSTEL/HOTEL/BED_AND_BREAKFAST), description, star_rating, is_new, is_featured, is_promoted, is_very_popular, is_hostelworld_recommended, has_free_cancellation, sustainability_levels, address, district, districts, city (id, name, country), country, latitude, longitude, distance_from_center, distance_unit, review_count, rating (overall, value, security, location, staff, atmosphere, cleanliness, facilities), currency, lowest_price_per_night, lowest_dorm_price_per_night, lowest_private_price_per_night, promotions (id, type, name, discount, stack), images and facilities (name, facilities).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string required — City to search hostels in: a city name or a Hostelworld numeric city id (examples: "London", "Berlin", "Bangkok", "3"; minLength: 1)
• check_in string nullable — Check-in date (YYYY-MM-DD) to return live nightly prices. Omit for listings without prices (examples: "2026-08-15"; pattern: ^\d{4}-\d{2}-\d{2}$)
• nights integer — Number of nights for the stay (default: 1; min: 1)
• guests integer — Number of guests (default: 1; min: 1)
• currency string — Currency for nightly prices (default: "USD"; minLength: 3; maxLength: 3)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "HostelworldSearchProperty")
• id string required
• url string nullable
• name string nullable
• property_type string nullable
• description string nullable
• star_rating integer nullable
• is_new boolean nullable
• is_featured boolean nullable
• is_promoted boolean nullable
• is_very_popular boolean nullable
• is_hostelworld_recommended boolean nullable
• has_free_cancellation boolean nullable
• sustainability_levels array (default: [])
• address string nullable
• district string nullable
• districts array (default: [])
• city object nullable
  • @type string (default: "HostelworldCity")
  • id string nullable
  • name string nullable
  • country string nullable
• country string nullable
• latitude number nullable
• longitude number nullable
• distance_from_center number nullable
• distance_unit string 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
• currency string nullable
• lowest_price_per_night number nullable
• lowest_dorm_price_per_night number nullable
• lowest_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
• images array (default: [])
• facilities array (default: [])
  • @type string (default: "HostelworldFacilityCategory")
  • name string required
  • facilities 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 — City not found (no Hostelworld city matches the given name) 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.