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
}
'
import requests

url = "https://api.anysite.io/api/hostelworld/properties/availability"

payload = {
"property": "<string>",
"checkin": "<string>",
"checkout": "<string>",
"timeout": 300,
"guests": 1
}
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({
property: '<string>',
checkin: '<string>',
checkout: '<string>',
timeout: 300,
guests: 1
})
};

fetch('https://api.anysite.io/api/hostelworld/properties/availability', 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/availability",
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([
'property' => '<string>',
'checkin' => '<string>',
'checkout' => '<string>',
'timeout' => 300,
'guests' => 1
]),
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/availability"

payload := strings.NewReader("{\n \"property\": \"<string>\",\n \"checkin\": \"<string>\",\n \"checkout\": \"<string>\",\n \"timeout\": 300,\n \"guests\": 1\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/availability")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"property\": \"<string>\",\n \"checkin\": \"<string>\",\n \"checkout\": \"<string>\",\n \"timeout\": 300,\n \"guests\": 1\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.anysite.io/api/hostelworld/properties/availability")

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 \"property\": \"<string>\",\n \"checkin\": \"<string>\",\n \"checkout\": \"<string>\",\n \"timeout\": 300,\n \"guests\": 1\n}"

response = http.request(request)
puts response.read_body
[
  {
    "property_id": "<string>",
    "checkin": "<string>",
    "checkout": "<string>",
    "nights": 123,
    "guests": 123,
    "@type": "HostelworldAvailability",
    "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": []
  }
]
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

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[]