Hostelworld city search
Hostels and budget stays of a city for given dates: id, name, type, rating out of 10 with count and category scores, address, district, distance to the centre, lowest price per night (dorm and private, with the pre-discount price), free cancellation deadline, flags, overview, images and facilities, plus the city's price range. Find a city id from a hostelworld.com city page or pass its URL as city. Pass next_page back as page; null on the last page.
sort and property_type are applied by the site across all pages. min_rating, max_price, free_cancellation, district and facilities filter the properties of the page read; with any of them set, page_size gives the page's size before filtering. filters echoes every choice.
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
city_idrequired | string | Hostelworld city id (14 = Paris, 26 = Berlin, 3 = London). Or give city with a hostelworld.com city page URL such as https://www.hostelworld.com/hostels/europe/germany/berlin/. Example: 14 |
checkin | string | Check-in date (YYYY-MM-DD). Default 14 days from today. |
nights | integer | Nights, 1-30. Example: 2 |
guests | integer | Guests, 1-20. Example: 1 |
currency | string | Price currency (EUR, USD, GBP...). Example: EUR |
per_page | integer | Properties per page, 1-50. Example: 30 |
page | integer | Page number, starting at 1. Pass next_page back as page; it is null on the last page. Example: 1 |
sort | popularity | price | price_desc | rating | distance | Order: popularity (default), price (cheapest first), price_desc, rating (best first), distance (closest to the centre first). |
property_type | hostel | hotel | guesthouse | apartment | campsite | Only this property type. |
min_rating | number | Keep only properties rated at least this (0-10), e.g. 8.5. |
max_price | number | Keep only properties whose lowest price per night is at most this (in currency). |
free_cancellation | 1 | 0 | Set to 1 to keep only properties offering free cancellation. |
district | string | Keep only properties whose district name contains this text, e.g. Montmartre. |
facilities | string | Keep only properties listing every one of these facilities (comma list, matched as text), e.g. wifi,breakfast. |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/hostelworld/v1/search?city_id=14" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/hostelworld/v1/search",
params={"city_id": "14"},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json() const url = new URL("https://api.api.sh/hostelworld/v1/search");
url.searchParams.set("city_id", "14");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json(); Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).