Skip to main content
POST
/
api
/
hostelworld
/
properties
/hostelworld/properties
curl --request POST \
  --url https://api.anysite.io/api/hostelworld/properties \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "property": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "@type": "@hostelworld_property",
    "url": "<string>",
    "name": "<string>",
    "property_type": "<string>",
    "description": "<string>",
    "hostelworld_says": "<string>",
    "directions": "<string>",
    "house_rules": "<string>",
    "star_rating": 123,
    "is_new": true,
    "is_featured": true,
    "is_promoted": true,
    "is_hostelworld_recommended": true,
    "best_for": [],
    "policies": [],
    "sustainability_levels": [],
    "currency": "<string>",
    "business_number": "<string>",
    "address": "<string>",
    "city": {
      "@type": "@hostelworld_city",
      "id": "<string>",
      "name": "<string>",
      "country": "<string>"
    },
    "region": "<string>",
    "latitude": 123,
    "longitude": 123,
    "distance_from_center_km": 123,
    "distance_from_center_miles": 123,
    "review_count": 123,
    "rating": {
      "@type": "@hostelworld_rating",
      "overall": 123,
      "value": 123,
      "security": 123,
      "location": 123,
      "staff": 123,
      "atmosphere": 123,
      "cleanliness": 123,
      "facilities": 123
    },
    "deposit_percentage": 123,
    "max_guests_per_booking": 123,
    "check_in_from": "<string>",
    "check_in_until": "<string>",
    "latest_checkout": "<string>",
    "has_free_cancellation": true,
    "free_cancellation_days": 123,
    "cancellation_policy": {
      "@type": "@hostelworld_property_cancellation_policy",
      "deposit_only": {
        "@type": "@hostelworld_cancellation_sub_policy",
        "description": "<string>",
        "days": 123
      },
      "non_refundable": {
        "@type": "@hostelworld_cancellation_sub_policy",
        "description": "<string>",
        "days": 123
      },
      "free_cancellation": {
        "@type": "@hostelworld_cancellation_sub_policy",
        "description": "<string>",
        "days": 123
      }
    },
    "is_tax_included": true,
    "taxes": [],
    "is_fee_included": true,
    "fees": [],
    "group_info": {
      "@type": "@hostelworld_group_info",
      "additional_terms": "<string>",
      "cancellation_terms": "<string>",
      "group_terms": "<string>",
      "remainder_due": "<string>",
      "group_max_pax": 123,
      "group_types": [],
      "age_ranges": []
    },
    "facilities": [],
    "images": [],
    "videos": [],
    "payment_methods": [],
    "awards": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
property
string
required

Hostelworld property id or a property URL containing it

Minimum string length: 1
Examples:

"39493"

"https://www.hostelworld.com/hostels/p/39493/onefam-waterloo/"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
@type
string
default:@hostelworld_property
url
string | null
name
string | null
property_type
string | null
description
string | null
hostelworld_says
string | null
directions
string | null
house_rules
string | null
star_rating
integer | null
is_new
boolean | null
is_promoted
boolean | null
best_for
string[]
policies
string[]
sustainability_levels
string[]
currency
string | null
business_number
string | null
address
string | null
city
HostelworldCity · object
region
string | null
latitude
number | null
longitude
number | null
distance_from_center_km
number | null
distance_from_center_miles
number | null
review_count
integer | null
rating
HostelworldRating · object
deposit_percentage
integer | null
max_guests_per_booking
integer | null
check_in_from
string | null
check_in_until
string | null
latest_checkout
string | null
has_free_cancellation
boolean | null
free_cancellation_days
integer | null
cancellation_policy
HostelworldPropertyCancellationPolicy · object
is_tax_included
boolean | null
taxes
HostelworldTax · object[]
is_fee_included
boolean | null
fees
HostelworldFee · object[]
group_info
HostelworldGroupInfo · object
facilities
HostelworldFacilityCategory · object[]
images
string[]
videos
string[]
payment_methods
string[]
awards
HostelworldAward · object[]