{ "openapi": "3.0.1", "info": { "title": "Hostelworld Property Ratings & Price Finder", "description": "Search Hostelworld hostels by city and dates, fetch specific property pages, or list top hostel cities, with ratings breakdown, prices, amenities, and location.", "version": "1.0", "x-build-id": "n1EEZzCPiKhxMKNPf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xyrelith-data~hostelworld-property-ratings-and-price-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xyrelith-data-hostelworld-property-ratings-and-price-finder", "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/xyrelith-data~hostelworld-property-ratings-and-price-finder/runs": { "post": { "operationId": "runs-sync-xyrelith-data-hostelworld-property-ratings-and-price-finder", "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/xyrelith-data~hostelworld-property-ratings-and-price-finder/run-sync": { "post": { "operationId": "run-sync-xyrelith-data-hostelworld-property-ratings-and-price-finder", "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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byUrl", "topCities", "availability", "rooms", "reviews" ], "type": "string", "description": "What to collect: city search, pasted URLs/IDs, a country city index, dated availability, room rate plans, or reviews.", "default": "search" }, "searchQueries": { "title": "Cities or destinations", "type": "array", "description": "City or destination names for search, availability, rooms and reviews. Example: London, Paris, Bangkok.", "default": [], "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Country names for topCities, or to expand a search when no city is given. Example: England, Thailand, Portugal.", "default": [], "items": { "type": "string" } }, "propertyUrls": { "title": "Property, city or search URLs", "type": "array", "description": "Hostelworld property, city or search URLs. Property URLs and IDs take priority over city queries in availability, rooms and reviews.", "default": [], "items": { "type": "string" } }, "propertyIds": { "title": "Property IDs", "type": "array", "description": "Numeric Hostelworld property IDs, for example 88047.", "default": [], "items": { "type": "string" } }, "dateFrom": { "title": "Check-in date", "type": "string", "description": "Check-in date in YYYY-MM-DD format. Required for room rows; optional for dated prices elsewhere." }, "dateTo": { "title": "Check-out date", "type": "string", "description": "Check-out date in YYYY-MM-DD format. Nights are derived; maximum stay is 30 nights." }, "daysAhead": { "title": "Days ahead", "minimum": 0, "maximum": 365, "type": "integer", "description": "Alternative to dateFrom for schedules: check in this many days from today." }, "numNights": { "title": "Nights", "minimum": 1, "maximum": 30, "type": "integer", "description": "Stay length when only dateFrom or daysAhead is set.", "default": 2 }, "guests": { "title": "Guests", "minimum": 1, "maximum": 20, "type": "integer", "description": "Party size used for availability and room prices.", "default": 2 }, "currency": { "title": "Currency", "enum": [ "EUR", "USD", "GBP", "AUD", "CAD", "NZD", "CHF", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "RON", "BGN", "HRK", "TRY", "RUB", "UAH", "ILS", "AED", "SAR", "QAR", "KWD", "BHD", "OMR", "JOD", "EGP", "ZAR", "KES", "TZS", "UGX", "RWF", "NAD", "SZL", "MAD", "TND", "MUR", "INR", "PKR", "BDT", "LKR", "NPR", "CNY", "HKD", "TWD", "JPY", "KRW", "SGD", "MYR", "THB", "IDR", "PHP", "VND", "KHR", "LAK", "MMK", "MNT", "KZT", "GEL", "AMD", "AZN", "MXN", "BRL", "ARS", "CLP", "COP", "PEN", "BOB", "PYG", "UYU", "CRC", "GTQ", "HNL", "NIO", "DOP", "BSD", "BZD", "XCD", "FJD", "PGK", "WST", "TOP", "VUV" ], "type": "string", "description": "Currency for every price field. Property-native price ranges are also returned in propertyPrices.", "default": "EUR" }, "language": { "title": "Language", "enum": [ "en", "de", "es", "fr", "it", "nl", "pt", "pt-br", "pl", "ru", "tr", "ja", "ko", "zh-cn", "sv", "da", "no", "fi", "cs" ], "type": "string", "description": "Language requested from Hostelworld for descriptions and labels.", "default": "en" }, "propertyType": { "title": "Property type", "enum": [ "all", "hostel", "hotel", "guesthouse", "apartment", "campsite" ], "type": "string", "description": "Keep only one accommodation type.", "default": "all" }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 10, "type": "number", "description": "Only properties rated at or above this value on the 0-10 scale." }, "minPrice": { "title": "Minimum price per night", "minimum": 0, "maximum": 10000, "type": "number", "description": "Only properties at or above this nightly price in the selected currency." }, "maxPrice": { "title": "Maximum price per night", "minimum": 0, "maximum": 10000, "type": "number", "description": "Only properties at or below this nightly price in the selected currency." }, "maxDistanceKm": { "title": "Maximum distance from centre (km)", "minimum": 0, "maximum": 50, "type": "number", "description": "Only properties within this many kilometres of the city centre." }, "freeCancellationOnly": { "title": "Free cancellation only", "type": "boolean", "description": "Keep only properties offering a free-cancellation rate.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "priceLow", "priceHigh", "ratingHigh", "reviewCount", "distance" ], "type": "string", "description": "Order of hostel rows. Ties are broken by property ID.", "default": "relevance" }, "includeDetails": { "title": "Include full profiles", "type": "boolean", "description": "Fetch the full profile for every hostel: facilities, policies, images, directions and payment methods. Turn off for the cheapest city listing.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Also emit review rows for hostels found in search or byUrl.", "default": false }, "reviewsPerProperty": { "title": "Reviews per property", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Maximum review rows per property for reviews mode or inline reviews.", "default": 10 }, "reviewsSort": { "title": "Review order", "enum": [ "-date", "date", "rating", "-rating" ], "type": "string", "description": "Hostelworld review sort order.", "default": "-date" }, "allLanguages": { "title": "All review languages", "type": "boolean", "description": "Include reviews in every language instead of English only.", "default": true }, "sinceDate": { "title": "Reviews since", "type": "string", "description": "Only reviews on or after this date (YYYY-MM-DD). Newest-first searches stop early." }, "reviewRatingMin": { "title": "Review score minimum", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only reviews at or above this score on the 0-100 scale." }, "reviewRatingMax": { "title": "Review score maximum", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only reviews at or below this score on the 0-100 scale." }, "requireReviewText": { "title": "Require review text", "type": "boolean", "description": "Drop score-only reviews without written text.", "default": false }, "roomCategory": { "title": "Room category", "enum": [ "all", "dorm", "private" ], "type": "string", "description": "Filter room rows to dorms or private rooms.", "default": "all" }, "maxItems": { "title": "Max hostels", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on hostel rows. Rooms and reviews use their own per-property caps.", "default": 50 } } }, "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 } } } } } } } } } }