{ "openapi": "3.0.1", "info": { "title": "Booking.com Scraper - Hotel Prices, Ratings & Details", "description": "Collect Booking.com accommodations worldwide by destination or hotel URL. Extract stay prices, ratings, addresses and available hotel details. Pay per delivered property row, plus a start fee.", "version": "0.3", "x-build-id": "fGgwBLS8vgifQEeVt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~booking-hotels-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-booking-hotels-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/lentic_clockss~booking-hotels-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-booking-hotels-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/lentic_clockss~booking-hotels-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-booking-hotels-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": { "destination": { "title": "Destination", "type": "string", "description": "City, region, country, area or landmark, such as Tokyo or Lombardia. Fill this or detailUrls; leaving both empty starts a small example search." }, "detailUrls": { "title": "Hotel detail URLs", "type": "array", "description": "Booking.com hotel page URLs; these take priority over destination search and require enrichDetails=true. The list shares maxResults and detailEnrichLimit (at most 30); fewer properties may be returned when details are unavailable.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Max results per destination", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum property rows for the destination, default 70; larger searches are collected in parts of 70, subject to the maximum cost per run. Hotel URL lists share this limit and detailEnrichLimit; Free-plan users have a 200-row run cap and a 10-run allowance set by the publisher.", "default": 70 }, "checkin": { "title": "Check-in Date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Arrival date in YYYY-MM-DD, today or later and no more than 500 days ahead. Leave both dates empty for arrival in 21 days and a two-night stay." }, "checkout": { "title": "Check-out Date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Departure date in YYYY-MM-DD, after arrival. If only one date is supplied, the missing date completes a two-night stay." }, "adults": { "title": "Number of Adults", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of adult guests, from 1 to 10.", "default": 2 }, "children": { "title": "Number of Children", "minimum": 0, "maximum": 10, "type": "integer", "description": "Number of children, from 0 to 10. Missing child ages are filled with 8.", "default": 0 }, "childAges": { "title": "Child Ages", "type": "array", "description": "Child ages from 0 to 17. When children is set, the list is padded with age 8 or shortened to match; otherwise valid ages determine the child count.", "items": { "type": "integer", "minimum": 0, "maximum": 17 }, "default": [] }, "rooms": { "title": "Number of Rooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of rooms requested, from 1 to 10.", "default": 1 }, "currency": { "title": "Currency", "pattern": "^[A-Za-z]{3}$", "type": "string", "description": "Preferred ISO currency code (e.g. 'USD', 'EUR', 'SGD'). Each row's currency field says which currency the shown price is in.", "default": "USD" }, "lang": { "title": "Language", "pattern": "^[A-Za-z]{2}([-_][A-Za-z]{2})?$", "type": "string", "description": "Display language for property information, such as en-us, en-gb, de, fr or ja.", "default": "en-us" }, "sort": { "title": "Sort", "enum": [ "popularity", "price", "review_score", "review_and_price", "stars_desc", "stars_asc", "distance", "homes_first" ], "type": "string", "description": "Order of properties in destination search results.", "default": "popularity" }, "propertyTypes": { "title": "Property Types", "type": "array", "description": "Accommodation categories to include. Leave empty to include all categories.", "items": { "type": "string", "enum": [ "hotel", "apartment", "hostel", "motel", "resort", "bed_and_breakfast", "villa", "guesthouse", "holiday_home", "aparthotel", "lodge", "homestay", "country_house", "capsule_hotel", "campground", "inn", "ryokan", "riad", "chalet", "holiday_park", "tent", "love_hotel", "pension" ] }, "default": [] }, "stars": { "title": "Star Ratings", "type": "array", "description": "Hotel star classes to include, from 1 to 5. Leave empty for no star filter.", "items": { "type": "integer", "minimum": 1, "maximum": 5 }, "default": [] }, "minReviewScore": { "title": "Minimum Review Score", "minimum": 0, "maximum": 10, "type": "number", "description": "Minimum guest review score, from 0 to 10. Leave empty for no review-score filter." }, "freeCancellation": { "title": "Free Cancellation Only", "type": "boolean", "description": "Restrict destination searches to offers with free cancellation.", "default": false }, "enrichDetails": { "title": "Enrich hotel details", "type": "boolean", "description": "Add available public hotel details to up to detailEnrichLimit property rows. Contact fields can remain empty; rows without enrichment include reasons for missing information.", "default": true }, "detailEnrichLimit": { "title": "Detail enrichment limit", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum properties to enrich, from 1 to 30, default 3. This also limits the number of supplied hotel URLs processed; other search rows remain in the results without enrichment.", "default": 3 }, "destId": { "title": "Destination ID", "type": "string", "description": "Known Booking.com destination identifier. Supply it with destType to use that destination directly.", "default": "" }, "destType": { "title": "Destination Type", "enum": [ "", "city", "region", "country", "landmark", "airport", "district", "hotel", "coordinates" ], "type": "string", "description": "Destination kind paired with destId, such as city, region, country or landmark.", "default": "" }, "customNfltFilters": { "title": "Custom nflt Filters", "type": "array", "description": "Additional Booking.com filter fragments, such as class=5, oos=1 or review_score=80. These are combined with the selected accommodation filters.", "items": { "type": "string" }, "default": [] }, "country": { "title": "Country hint", "type": "string", "description": "Country name or code, such as US, GB or Germany. Use as a hint when a postal code or address cannot be matched to a destination.", "default": "" } } }, "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 } } } } } } } } } }