Skip to main content
POST
/hostelworld/properties/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
city
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
check_in
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
nights
integer
default:1
Required range: x >= 1
guests
integer
default:1
Required range: x >= 1
currency
string
default:USD
Required string length: 3

Response

Successful Response

id
string
required
@type
string
default:HostelworldSearchProperty
url
string | null
name
string | null
property_type
string | null
star_rating
integer | null
is_new
boolean | null
is_promoted
boolean | null
has_free_cancellation
boolean | null
sustainability_levels
string[]
address
string | null
district
string | null
districts
string[]
city
object | null
country
string | null
latitude
number | null
longitude
number | null
distance_from_center
number | null
distance_unit
string | null
review_count
integer | null
rating
object | null
currency
string | null
lowest_price_per_night
number | null
lowest_dorm_price_per_night
number | null
lowest_private_price_per_night
number | null
promotions
object[]
images
string[]
facilities
object[]