{ "openapi": "3.0.1", "info": { "title": "Hostelworld Scraper — Hostels, Prices, Ratings & Facilities", "description": "Scrape Hostelworld hostels, hotels and B&Bs by city or whole country: name, address, coordinates, rating with 7 sub-ratings, review count, dorm and private room prices in your currency, badges and photos. Optional: facilities, check-in times, cancellation and house rules. No login.", "version": "0.1", "x-build-id": "bLhgIK06L0viwLlmn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~hostelworld-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-hostelworld-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/yugenox~hostelworld-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-hostelworld-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/yugenox~hostelworld-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-hostelworld-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": { "cities": { "title": "📍 Cities", "type": "array", "description": "City names, e.g. \"Lisbon\", \"Porto, Portugal\", \"Ho Chi Minh, Vietnam\". Add the country when a city name exists in several countries. You can also paste Hostelworld city, district or filter page URLs here.", "items": { "type": "string" } }, "countries": { "title": "🌍 Whole countries", "type": "array", "description": "Every city of a country, in Hostelworld’s order (most popular first), e.g. \"Portugal\", \"Thailand\", \"UK\". Max properties caps the run.", "items": { "type": "string" } }, "startUrls": { "title": "🔗 Hostelworld URLs", "type": "array", "description": "Optional: hostelworld.com property pages (…/hostels/p/12345/name/), city pages (…/hostels/europe/portugal/lisbon/), district or filter pages (…/d/alfama/, …/f/party/), page 2+ (…/p/2/) or country pages.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "propertyType": { "title": "Property type", "enum": [ "hostels", "hotels", "bed-and-breakfasts" ], "type": "string", "description": "Which Hostelworld list to read for cities and countries. Hotel and B&B lists also contain some hostels; every row says its own type.", "default": "hostels" }, "maxItems": { "title": "Max properties", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of properties for the whole run, shared fairly between your cities and countries. 0 = everything.", "default": 100 }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "NZD", "CHF", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "RON", "ISK", "TRY", "JPY", "CNY", "HKD", "TWD", "KRW", "SGD", "MYR", "THB", "IDR", "PHP", "VND", "INR", "LKR", "NPR", "PKR", "BDT", "AED", "SAR", "QAR", "KWD", "BHD", "OMR", "JOD", "ILS", "EGP", "MAD", "TND", "ZAR", "KES", "TZS", "UGX", "NAD", "MXN", "BRL", "ARS", "CLP", "COP", "PEN", "UYU", "PYG", "BOB", "CRC", "GTQ", "DOP", "UAH", "GEL", "AMD", "AZN", "KZT" ], "type": "string", "description": "Prices are returned in this currency (Hostelworld converts them).", "default": "USD" }, "includeDetails": { "title": "Include property page details", "type": "boolean", "description": "Also open every property page for the postcode, full description, all photos, every facility (grouped), check-in and check-out times, free cancellation, pets, age limits, curfew, house rules, payment methods, awards, current promotions and Hostelworld’s review summary. One extra request per property, charged separately.", "default": false }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 10, "type": "number", "description": "Only properties rated at least this (0–10), e.g. 8. Properties without a rating are left out when this is set. Left-out properties are not charged.", "default": 0 }, "minReviews": { "title": "Minimum reviews", "minimum": 0, "type": "integer", "description": "Only properties with at least this many reviews.", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default and comes with every Apify plan. If Hostelworld refuses datacenter IPs for a while, the run switches to residential proxies when your account has them.", "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 } } } } } } } } } }