# Hostelworld rooms: `POST /v1/ota/hostelworld`

Cost: 12 credits (12 (failed requests are free)). Docs: https://scrapercompany.com/docs/reference/hostelworld-rooms

Hostelworld: every dorm bed and private room with rate plans.

Currency is NOT selectable — Hostelworld returns the property's native
currency (typically GBP for UK hostels). Per-bed pricing for dorms,
per-room pricing for privates.

Request body (JSON):

- `property_id` (string; required; min length 1): Numeric property id from Hostelworld URL, e.g. `hostelworld.com/pwa/hosteldetails.php/88047/...`.
- `check_in` (string (date); required): First night of the stay, `YYYY-MM-DD`.
- `check_out` (string (date) | null; optional): Departure date. An alternative to `nights` — if both are given, this wins.
- `nights` (integer; optional; default 1; min 1, max 30): Length of stay. Ignored when `check_out` is supplied.
- `guests` (integer; optional; default 1; min 1, max 8): Number of guests. For dorms, this is the number of beds needed. For private rooms, this is the occupancy.

Response fields:

- `search_parameters` (object; required)
  - `search_parameters.engine` (string; required; one of hostelworld_property)
  - `search_parameters.property_id` (string; required)
  - `search_parameters.check_in_date` (string (date); required)
  - `search_parameters.check_out_date` (string (date); required)
  - `search_parameters.guests` (integer; required)
- `property` (object; required)
  - `property.property_id` (string; required)
  - `property.price_per_night` (number | null; required)
  - `property.currency` (string; required): The property's native currency.
  - `property.sold_out` (boolean; required)
  - `property.deposit_percentage` (number | null; required)
  - `property.free_cancellation_available` (boolean; required)
  - `property.vat` (number; required)
  - `property.provenance` (object | null; required): Provenance of the cheapest priced row; null when nothing priced.
  - `property.rooms` (array of object; required)
- `meta` (object; required)
  - `meta.source` (string; required; one of hostelworld)
  - `meta.collection_id` (string; required)
  - `meta.observed_at` (string; required)
  - `meta.nights` (integer; required)
  - `meta.elapsed_s` (number; required)
  - `meta.dorms_count` (integer; required)
  - `meta.privates_count` (integer; required)
  - `meta.total_rate_plans` (integer; required)
  - `meta.comparable_across_markets` (boolean; required): Always false.
  - `meta.notes` (string; required)

Base URL: `https://api.scrapercompany.com`. Auth: send your key in the `x-api-key` header. A failed request (4xx or 5xx) or an empty result costs 0 credits.

- [Full API reference as one Markdown file](https://scrapercompany.com/llms-full.txt)
- [OpenAPI spec](https://scrapercompany.com/openapi.json)
