# Hostelworld Room Availability API Documentation

Hostelworld Room Availability API Documentation Retrieve the bookable room types of one Hostelworld property for a stay, split into dorms and private rooms. Each room has its name, description, capacity, bathroom type, free beds, a price per night and total price for the cheapest rate plan, all rate plans with refund type and prices, and photos. Also returns the lowest dorm and private price, free cancellation info and cancellation policies. A property with no free rooms returns empty dorms and privates and is billable. An unknown property id returns a 404 that is not billed.

- **Documentation:** [https://scrappa.co/docs/hostelworld-api/hostelworld_availability](https://scrappa.co/docs/hostelworld-api/hostelworld_availability) - **API group:** Hostelworld API - **Endpoint:** `GET https://scrappa.co/api/hostelworld/availability` ## Authentication Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key. ## Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `property_id` | integer | Yes | Hostelworld property id. Example: 15426. | | `check_in` | string | Yes | Check-in date, YYYY-MM-DD, today or later. | | `nights` | integer | No | Number of nights, 1 to 30. Defaults to 2. | | `guests` | integer | No | Number of guests, 1 to 20. Defaults to 2. | | `currency` | string | No | ISO 4217 currency code for all prices, for example EUR or USD. Defaults to EUR. | ## Example response ```json { "data": { "dorms": [ { "id": 721132, "name": "4 Bed Mixed Dorm", "type": "Mixed Dorm", "images": [ "https://a.hwstatic.com/image/upload/f_auto,q_auto/v1/propertyimages/1/15426/qehdon8btnseihrhddxi" ], "ensuite": false, "capacity": 4, "rate_plans": [ { "id": 424261, "type": "standard", "payment": "Deposit only", "total_price": { "amount": 58.03, "currency": "EUR" }, "is_refundable": true, "price_per_night": { "amount": 29.02, "currency": "EUR" }, "original_price_per_night": { "amount": 32.24, "currency": "EUR" } }, { "id": 748162, "type": "bed_and_breakfast", "payment": "Non-refundable", "total_price": { "amount": 66.73, "currency": "EUR" }, "is_refundable": false, "price_per_night": { "amount": 33.37, "currency": "EUR" }, "original_price_per_night": { "amount": 37.08, "currency": "EUR" } } ], "description": "Dormitory style and range in size from 2 beds upwards. They offer mixed accommodation.", "total_price": { "amount": 52.75, "currency": "EUR" }, "beds_available": 8, "price_per_night": { "amount": 20.88, "currency": "EUR" } } ], "guests": 2, "nights": 2, "check_in": "2026-11-14", "currency": "EUR", "privates": [ { "id": 721133, "name": "Single Private Shared Bathroom", "type": "Private", "images": [ "https://a.hwstatic.com/image/upload/f_auto,q_auto/v1/propertyimages/1/15426/cxvnz8b7ekntkcicupzp" ], "ensuite": false, "capacity": 1, "rate_plans": [ { "id": 424262, "type": "standard", "payment": "Deposit only", "total_price": { "amount": 165.5, "currency": "EUR" }, "is_refundable": true, "price_per_night": { "amount": 82.75, "currency": "EUR" }, "original_price_per_night": { "amount": 91.94, "currency": "EUR" } }, { "id": 748141, "type": "bed_and_breakfast", "payment": "Non-refundable", "total_price": { "amount": 164.44, "currency": "EUR" }, "is_refundable": false, "price_per_night": { "amount": 82.22, "currency": "EUR" }, "original_price_per_night": { "amount": 91.36, "currency": "EUR" } } ], "description": "Private Room with 1 single bed, sleeps one person.", "total_price": { "amount": 150.45, "currency": "EUR" }, "beds_available": 1, "price_per_night": { "amount": 54.55, "currency": "EUR" }, "rooms_available": 1 } ], "property_id": 15426, "free_cancellation": true, "deposit_percentage": 13, "cancellation_policies": [ { "label": "Free Cancellation rates", "description": "If you cancel your booking before 23:59 12th Nov 2026 (CET) your deposit will be refunded to your payment card. If you cancel after 23:59 12th Nov 2026 (CET) or in the event of a no-show, your deposit will not be refunded and the total of the first night's accommodation will be charged to your payment card, unless otherwise stated (see 'Things to Note' information). Please note that cancellations must be made directly within your booking in My Account." } ], "lowest_price_per_night": { "amount": 13.89, "currency": "EUR" }, "free_cancellation_until": "2026-11-12T22:59:59Z", "lowest_dorm_price_per_night": { "amount": 13.89, "currency": "EUR" }, "lowest_private_price_per_night": { "amount": 54.55, "currency": "EUR" } }, "meta": { "billable": true, "endpoint_family": "availability" }, "success": true } ``` ## Errors | Status | Error | Description | | --- | --- | --- | | 422 | Validation Error | A required query parameter is missing or invalid. This response is not billable. | | 404 | Resource Not Found | The requested Hostelworld property does not exist. This response is not billable. | | 503 | Invalid Source Response | Hostelworld answered with a shape that no longer matches the documented contract. This response is not billable. | | 503 | Service Unavailable | The upstream service is temporarily unavailable. Please retry shortly. | ## More Scrappa resources - [API documentation](https://scrappa.co/docs) - [Full LLM-readable API reference](https://scrappa.co/llms-full.txt) - [OpenAPI specification](https://scrappa.co/docs/api.json) - [Pricing](https://scrappa.co/pricing)