/hostelworld/properties/search
curl --request POST \
--url https://api.anysite.io/api/hostelworld/properties/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"city": "<string>",
"count": 2,
"timeout": 300,
"check_in": "<string>",
"nights": 1,
"guests": 1,
"currency": "USD"
}
'import requests
url = "https://api.anysite.io/api/hostelworld/properties/search"
payload = {
"city": "<string>",
"count": 2,
"timeout": 300,
"check_in": "<string>",
"nights": 1,
"guests": 1,
"currency": "USD"
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
city: '<string>',
count: 2,
timeout: 300,
check_in: '<string>',
nights: 1,
guests: 1,
currency: 'USD'
})
};
fetch('https://api.anysite.io/api/hostelworld/properties/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/hostelworld/properties/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'city' => '<string>',
'count' => 2,
'timeout' => 300,
'check_in' => '<string>',
'nights' => 1,
'guests' => 1,
'currency' => 'USD'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/hostelworld/properties/search"
payload := strings.NewReader("{\n \"city\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"check_in\": \"<string>\",\n \"nights\": 1,\n \"guests\": 1,\n \"currency\": \"USD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/hostelworld/properties/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"city\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"check_in\": \"<string>\",\n \"nights\": 1,\n \"guests\": 1,\n \"currency\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/hostelworld/properties/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"city\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"check_in\": \"<string>\",\n \"nights\": 1,\n \"guests\": 1,\n \"currency\": \"USD\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "HostelworldSearchProperty",
"url": "<string>",
"name": "<string>",
"property_type": "<string>",
"star_rating": 123,
"is_new": true,
"is_featured": true,
"is_promoted": true,
"is_very_popular": true,
"is_hostelworld_recommended": true,
"has_free_cancellation": true,
"sustainability_levels": [],
"address": "<string>",
"district": "<string>",
"districts": [],
"city": {
"@type": "HostelworldCity",
"id": "<string>",
"name": "<string>",
"country": "<string>"
},
"country": "<string>",
"latitude": 123,
"longitude": 123,
"distance_from_center": 123,
"distance_unit": "<string>",
"review_count": 123,
"rating": {
"@type": "HostelworldRating",
"overall": 123,
"value": 123,
"security": 123,
"location": 123,
"staff": 123,
"atmosphere": 123,
"cleanliness": 123,
"facilities": 123
},
"currency": "<string>",
"lowest_price_per_night": 123,
"lowest_dorm_price_per_night": 123,
"lowest_private_price_per_night": 123,
"promotions": [],
"images": [],
"facilities": []
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/hostelworld
/hostelworld/properties/search
Search Hostelworld properties (hostels, hotels, B&Bs) in a city. Returns property cards with name, type, description, address, district, city, coordinates, distance from the city centre, star rating, guest rating breakdown, review count, facilities by category, photos and the lowest nightly prices. Provide a check-in date to get live nightly prices.
Price: 10 credits per 20 results
⚠️ Common errors: 412: City not found (no Hostelworld city matches the given name)
POST
/
api
/
hostelworld
/
properties
/
search
/hostelworld/properties/search
curl --request POST \
--url https://api.anysite.io/api/hostelworld/properties/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"city": "<string>",
"count": 2,
"timeout": 300,
"check_in": "<string>",
"nights": 1,
"guests": 1,
"currency": "USD"
}
'import requests
url = "https://api.anysite.io/api/hostelworld/properties/search"
payload = {
"city": "<string>",
"count": 2,
"timeout": 300,
"check_in": "<string>",
"nights": 1,
"guests": 1,
"currency": "USD"
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
city: '<string>',
count: 2,
timeout: 300,
check_in: '<string>',
nights: 1,
guests: 1,
currency: 'USD'
})
};
fetch('https://api.anysite.io/api/hostelworld/properties/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/hostelworld/properties/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'city' => '<string>',
'count' => 2,
'timeout' => 300,
'check_in' => '<string>',
'nights' => 1,
'guests' => 1,
'currency' => 'USD'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/hostelworld/properties/search"
payload := strings.NewReader("{\n \"city\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"check_in\": \"<string>\",\n \"nights\": 1,\n \"guests\": 1,\n \"currency\": \"USD\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/hostelworld/properties/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"city\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"check_in\": \"<string>\",\n \"nights\": 1,\n \"guests\": 1,\n \"currency\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/hostelworld/properties/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"city\": \"<string>\",\n \"count\": 2,\n \"timeout\": 300,\n \"check_in\": \"<string>\",\n \"nights\": 1,\n \"guests\": 1,\n \"currency\": \"USD\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "HostelworldSearchProperty",
"url": "<string>",
"name": "<string>",
"property_type": "<string>",
"star_rating": 123,
"is_new": true,
"is_featured": true,
"is_promoted": true,
"is_very_popular": true,
"is_hostelworld_recommended": true,
"has_free_cancellation": true,
"sustainability_levels": [],
"address": "<string>",
"district": "<string>",
"districts": [],
"city": {
"@type": "HostelworldCity",
"id": "<string>",
"name": "<string>",
"country": "<string>"
},
"country": "<string>",
"latitude": 123,
"longitude": 123,
"distance_from_center": 123,
"distance_unit": "<string>",
"review_count": 123,
"rating": {
"@type": "HostelworldRating",
"overall": 123,
"value": 123,
"security": 123,
"location": 123,
"staff": 123,
"atmosphere": 123,
"cleanliness": 123,
"facilities": 123
},
"currency": "<string>",
"lowest_price_per_night": 123,
"lowest_dorm_price_per_night": 123,
"lowest_private_price_per_night": 123,
"promotions": [],
"images": [],
"facilities": []
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API token from the dashboard
Headers
Body
application/json
Minimum string length:
1Required range:
x >= 1Required range:
20 <= x <= 1500Pattern:
^\d{4}-\d{2}-\d{2}$Required range:
x >= 1Required range:
x >= 1Required string length:
3Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes