Skip to main content
POST
/
api
/
hostelworld
/
properties
/
availability
/hostelworld/properties/availability
curl --request POST \
  --url https://api.anysite.io/api/hostelworld/properties/availability \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "property": "<string>",
  "checkin": "<string>",
  "checkout": "<string>",
  "timeout": 300,
  "guests": 1
}
'
[
  {
    "property_id": "<string>",
    "checkin": "<string>",
    "checkout": "<string>",
    "nights": 123,
    "guests": 123,
    "@type": "@hostelworld_availability",
    "url": "<string>",
    "currency": "<string>",
    "is_available": true,
    "deposit_percentage": 123,
    "has_free_cancellation": true,
    "free_cancellation_until": "<string>",
    "lowest_price_per_night": 123,
    "lowest_dorm_price_per_night": 123,
    "lowest_private_price_per_night": 123,
    "lowest_average_price_per_night": 123,
    "lowest_average_dorm_price_per_night": 123,
    "lowest_average_private_price_per_night": 123,
    "promotions": [],
    "cancellation_policies": [],
    "rooms": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
property
string
required

Hostelworld property id or a property URL containing it

Minimum string length: 1
Examples:

"39493"

"https://www.hostelworld.com/hostels/p/39493/onefam-waterloo/"

checkin
string
required

Check-in date in YYYY-MM-DD format

Example:

"2026-08-10"

checkout
string
required

Check-out date in YYYY-MM-DD format

Example:

"2026-08-13"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
guests
integer
default:1

Number of guests

Required range: 1 <= x <= 8

Response

Successful Response

property_id
string
required
checkin
string
required
checkout
string
required
nights
integer
required
guests
integer
required
@type
string
default:@hostelworld_availability
url
string | null
currency
string | null
is_available
boolean | null
deposit_percentage
integer | null
has_free_cancellation
boolean | null
free_cancellation_until
string | null
lowest_price_per_night
number | null
lowest_dorm_price_per_night
number | null
lowest_private_price_per_night
number | null
lowest_average_price_per_night
number | null
lowest_average_dorm_price_per_night
number | null
lowest_average_private_price_per_night
number | null
promotions
HostelworldPromotion · object[]
cancellation_policies
HostelworldCancellationPolicy · object[]
rooms
HostelworldRoom · object[]