/hostelworld/properties/events

POST /api/hostelworld/properties/events

Price: 1 credit

Get Hostelworld community-activity aggregates for a property by property id (or property URL): the number of free Linkups (social events the hostel organises for guests) with preview images, plus a social proof of how many travellers are staying and a sample of their nationalities. Low-frequency aggregation; counts and the traveller sample drift over time.

How to use it

Fetch community-activity aggregates for a single Hostelworld property by numeric property id or a property URL. Returns one item with id, url, linkup_count (number of free social events the hostel runs), linkup_images (event preview images), staying_traveler_count (how many travellers are staying) and travelers (a sample of recent guests with nationality and country_code). A property with no current events or travellers returns the item with null counts and empty lists. Property details, ratings and facilities are a separate endpoint.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — Hostelworld property id or a property URL containing it (examples: "39493", "https://www.hostelworld.com/hostels/p/39493/onefam-waterloo/"; minLength: 1)

Response

• @type string (default: "HostelworldPropertyEvents")
• id string required
• url string nullable
• linkup_count integer nullable
• linkup_images array (default: [])
• staying_traveler_count integer nullable
• travelers array (default: [])
  • @type string (default: "HostelworldTraveler")
  • nationality string nullable
  • country_code string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.