{ "openapi": "3.0.1", "info": { "title": "Booking.com API Scraper", "description": "Scrape Booking.com properties, live prices and full room-rate tables via the mobile API — by destination search or by hotel id.", "version": "1.0", "x-build-id": "myDDfweHARqHgsFwk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rl1987~booking-api-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rl1987-booking-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~booking-api-scraper/runs": { "post": { "operationId": "runs-sync-rl1987-booking-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~booking-api-scraper/run-sync": { "post": { "operationId": "run-sync-rl1987-booking-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": { "search": { "title": "Destination", "type": "string", "description": "Place name (city, region, landmark) resolved via Booking autocomplete. The easiest way to start — e.g. \"Amsterdam\". Leave the numeric ID fields empty if you use this." }, "city": { "title": "City ID (ufi)", "type": "integer", "description": "Advanced: exact numeric destination id (Demand `city`), e.g. -2140479 for Amsterdam. Use only if you already know the id; otherwise just fill in Destination above." }, "region": { "title": "Region ID", "type": "integer", "description": "Advanced: exact numeric region id (Demand `region`). Use only if you already know the id." }, "country": { "title": "Country code", "type": "string", "description": "ISO 2-letter country code (Demand `country`). Note: country-level search is not supported by the backend — prefer Destination, City ID or Region ID." }, "hotel_ids": { "title": "Hotel IDs", "type": "array", "description": "Scrape specific properties by their numeric Booking ID (bypasses search). Add one ID per line, e.g. 10004. When set, search/destination is ignored.", "items": { "type": "string" } }, "latitude": { "title": "Latitude", "type": "number", "description": "Optional coordinate search (Demand `coordinates`). Note: coordinate search is not supported by the backend and is ignored — use Destination/City/Region instead." }, "longitude": { "title": "Longitude", "type": "number", "description": "Longitude paired with Latitude. Accepted for parity; ignored by the backend." }, "radius": { "title": "Search radius (km)", "type": "number", "description": "Radius around the coordinates, in kilometres. Accepted for parity; ignored by the backend." }, "checkin": { "title": "Check-in", "type": "string", "description": "Arrival date. Defaults to 30 days from the run date." }, "checkout": { "title": "Check-out", "type": "string", "description": "Departure date. Defaults to check-in + 1 night." }, "rooms": { "title": "Rooms", "minimum": 1, "type": "integer", "description": "Number of rooms to book for.", "default": 1 }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Number of adult guests.", "default": 2 }, "childrenAges": { "title": "Children ages", "type": "array", "description": "Add one child age (in years) per line, e.g. 5 then 9 for two children. Leave empty for no children.", "items": { "type": "string" } }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD", "CHF", "CNY", "JPY", "INR", "BRL", "MXN", "SEK", "NOK", "DKK", "PLN", "AED", "SGD", "ZAR", "TRY", "RUB" ], "type": "string", "description": "Currency for displayed prices.", "default": "USD" }, "language": { "title": "Language / locale", "enum": [ "en-us", "en-gb", "de", "fr", "es", "it", "nl", "pt", "pt-br", "pl", "ru", "ja", "zh", "zh-tw", "ko", "ar", "tr", "sv", "da", "no", "fi" ], "type": "string", "description": "Locale for localized text (names, facilities, reviews).", "default": "en-us" }, "accommodationTypes": { "title": "Accommodation types", "type": "array", "description": "Limit results to these property types. Leave empty for all types.", "items": { "type": "string", "enum": [ "204", "201", "203", "205", "206", "208", "210", "213", "216", "220", "222", "223", "224", "225", "226", "228", "229" ], "enumTitles": [ "Hotels", "Apartments", "Hostels", "Motels", "Resorts", "Bed and breakfasts", "Guest houses", "Villas", "Holiday homes", "Lodges", "Country houses", "Apart-hotels", "Farm stays", "Boats", "Luxury tents / campsites", "Chalets", "Condos" ] }, "default": [] }, "minReviewScore": { "title": "Minimum review score", "minimum": 1, "maximum": 10, "type": "integer", "description": "Only return properties with at least this guest review score (1–10). Applied client-side." }, "minPrice": { "title": "Minimum price (per stay)", "minimum": 0, "type": "integer", "description": "Only return properties at or above this total stay price, in the selected currency. Applied client-side." }, "maxPrice": { "title": "Maximum price (per stay)", "minimum": 0, "type": "integer", "description": "Only return properties at or below this total stay price, in the selected currency. Applied client-side." }, "sortBy": { "title": "Sort by", "enum": [ "none", "price", "review_score" ], "type": "string", "description": "Order of the returned accommodations.", "default": "none" }, "sortDirection": { "title": "Sort direction", "enum": [ "ascending", "descending" ], "type": "string", "description": "Applies only when \"Sort by\" is set to Price or Review score.", "default": "ascending" }, "includeRooms": { "title": "Include rooms & products", "type": "boolean", "description": "Add both room sections: the per-rate `products` list (board, cancellation, deals, price) AND the distinct room-type `rooms` list (name, occupancy, availability, lowest price). Costs one extra request per property in search mode.", "default": false }, "includeDetails": { "title": "Include static details", "type": "boolean", "description": "Add a `details` object per property: name, type, star rating, review score/count, location, main photos, named facilities, languages spoken and address. Costs one extra request per property in search mode.", "default": false }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Add a `reviews` array per property (author, score, title, pros/cons, date). Costs one request per 10 reviews per property.", "default": false }, "maxReviews": { "title": "Max reviews per property", "minimum": 1, "type": "integer", "description": "How many reviews to fetch per property (only when \"Include reviews\" is on). Capped by the property's total review count.", "default": 10 }, "includeExtraCharges": { "title": "Include extra-charge breakdown", "type": "boolean", "description": "Add the `extra_charges` price breakdown (taxes/fees) to each result and product (Demand `extras: extra_charges`).", "default": true }, "maxItems": { "title": "Max accommodations", "minimum": 1, "type": "integer", "description": "Maximum number of accommodations to return.", "default": 100 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum parallel requests for product/detail fetches.", "default": 10 }, "bookerCountry": { "title": "Booker country code", "type": "string", "description": "ISO 2-letter country of the booker (Demand `booker.country`). Accepted for parity; affects some localized pricing." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Apify Proxy recommended.", "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 } } }, "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 } } } } } } } } } }