Skip to main content
POST
/hostelworld/properties/availability

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
property
string
required
Minimum string length: 1
checkin
string
required
checkout
string
required
timeout
integer
default:300
Required range: 20 <= x <= 1500
guests
integer
default:1
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:HostelworldAvailability
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
object[]
cancellation_policies
object[]
rooms
object[]