{
"openapi": "3.0.1",
"info": {
"title": "Hostelworld Scraper – Hostels, Dorm Prices & Reviews",
"description": "Search Hostelworld by city or look up hostels by ID or URL, and choose what a row is: a hostel, a dorm or private room with its own price, or a guest review. Flat columns only - ratings, dorm and private prices, pre-discount figures, facilities, policies, geo. Billed per hostel.",
"version": "0.0",
"x-build-id": "rglVeo9wnVXOedW4m"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/rl1987~hostelworld-api-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-rl1987-hostelworld-api-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/rl1987~hostelworld-api-scraper/runs": {
"post": {
"operationId": "runs-sync-rl1987-hostelworld-api-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/rl1987~hostelworld-api-scraper/run-sync": {
"post": {
"operationId": "run-sync-rl1987-hostelworld-api-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"mode": {
"title": "What one row is",
"enum": [
"search",
"properties",
"availability",
"rooms",
"reviews"
],
"type": "string",
"description": "The mode decides what one row is; the next section decides which hostels. Every mode accepts either a location or a list of hostels, so \"every review in Lisbon\" and \"the reviews of these three hostels\" are the same mode. Availability and Room types fetch the same request and cost the same — one gives you a hostel per row, the other a room per row.",
"default": "search"
},
"q": {
"title": "Location",
"type": "string",
"description": "A location to work on: a city, neighbourhood, or property name (e.g. Lisbon). Resolved via Hostelworld's own mobile autocomplete, so a misspelling returns no match rather than a guess. Works in every mode. Ignored when Hostel URLs or IDs is also filled in."
},
"propertyUrls": {
"title": "Hostel URLs or IDs",
"type": "array",
"description": "Work on these hostels instead of searching. Accepts a numeric property ID (98483) or any hostelworld.com property URL (https://www.hostelworld.com/hostels/p/98483/avenue-hostel-and-suites/). The name in the URL is cosmetic — only the ID matters, so a stale or truncated slug still works. Duplicates are collapsed before anything is billed.",
"items": {
"type": "string"
}
},
"includeDetails": {
"title": "Add hostel profiles",
"type": "boolean",
"description": "Add each hostel's own profile to the row: description, directions, facilities, policies, cancellation terms, fees, taxes and check-in/check-out times. One extra request per hostel, billed as Hostel profile ($3.00 per 1,000 from 26 Oct 2026). Mode Hostel profiles does this on its own.",
"default": true
},
"includeAvailability": {
"title": "Add room and dorm prices",
"type": "boolean",
"description": "Add live availability for the dates below: lowest dorm and private price per night, pre-discount prices, promotions, deposit terms and how many beds are free. One extra request per hostel, billed as Room and dorm availability ($3.00 per 1,000 from 26 Oct 2026). Setting a Check-in date turns this on by itself, which is how it worked before this input existed. For a row per room type, use mode Room types.",
"default": false
},
"reviewsPerProperty": {
"title": "Reviews per hostel",
"minimum": 1,
"type": "integer",
"description": "How many reviews to fetch per hostel, in the order below. Each review is a row and each review is billed, so this is your cost dial: a hostel can have hundreds (348 on one sampled hostel), and the default of 10 is one request. Values above 50 are fetched in pages of 50. Minimum 1 — unlike Max items, 0 is not \"all reviews\"; to skip reviews, use another mode.",
"default": 10
},
"reviewsSort": {
"title": "Review order",
"enum": [
"-date",
"date",
"-rating",
"rating"
],
"type": "string",
"description": "Which reviews you get when you ask for fewer than a hostel has. Lowest rated first is the one to use for complaint monitoring. Hostelworld ignores an unrecognised value silently, so anything outside this list is rejected before the run starts.",
"default": "-date"
},
"dateStart": {
"title": "Check-in date",
"type": "string",
"description": "Check-in date as YYYY-MM-DD. Defaults to tomorrow when availability is being fetched — not today, because same-day beds are often sold out and that reads as a broken actor rather than a full hostel. Must not be in the past — Hostelworld will not price a night that has gone, so a stale saved date is rejected before the run starts; use Days ahead for scheduled runs. In mode Hostels, setting this also switches room prices on. The date, nights and guest count are columns on every availability and room row, so an export says what the prices are for."
},
"daysAhead": {
"title": "Days ahead",
"minimum": 0,
"type": "integer",
"description": "Price this many days from the day the run starts — 0 tonight, 1 tomorrow, 7 a week out. Use this instead of Check-in date for scheduled monitoring: a relative target stays correct on every run, where a fixed date goes stale and eventually prices the past. Setting both is rejected."
},
"numNights": {
"title": "Nights",
"minimum": 1,
"maximum": 30,
"type": "integer",
"description": "Number of nights to price, 1 to 30. Hostelworld refuses 31 with an error on every hostel, even though its own message says the limit is 31 — measured, so 30 it is.",
"default": 2
},
"numberOfGuests": {
"title": "Number of guests",
"minimum": 1,
"type": "integer",
"description": "Guests to price for. Affects which dorm beds and private rooms are offered at all. A dorm price is per bed; a private price is for the whole room at this party size.",
"default": 2
},
"currency": {
"title": "Currency",
"type": "string",
"description": "Three-letter ISO currency code for every price in the output (EUR, USD, GBP, …). Applies to all modes. Case does not matter — usd is sent as USD, because Hostelworld rejects a lower-case code with an error on every request.",
"default": "EUR"
},
"maxItems": {
"title": "Max hostels",
"minimum": 0,
"type": "integer",
"description": "Maximum number of hostels to work on (0 = all of them). It caps hostels, not rows, because the hostel is what you are billed for: 20 hostels in mode Room types is 20 charges and perhaps 150 rows. When you paste a long list of IDs, raise it or set it to 0.",
"default": 50
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Route requests through a proxy (Apify Proxy by default).",
"default": {
"useApifyProxy": true
}
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}