{ "openapi": "3.0.1", "info": { "title": "Booking.com Search Scraper", "description": "Scrape Booking.com search results by destination. Returns hotel id, name, URL, price, taxes, review score, star rating, coordinates, address, district, room and bed setup, meals and cancellation policy. Dedupes past Booking's result cap, so you are never billed for repeat rows.", "version": "0.1", "x-build-id": "vRIKytPyPjwSFw4jg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~booking-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-booking-search-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/cirkit~booking-search-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-booking-search-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/cirkit~booking-search-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-booking-search-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", "required": [ "search" ], "properties": { "search": { "title": "Destinations", "minItems": 1, "type": "array", "description": "One or more destinations to search, exactly as you would type them into Booking.com. Cities, regions, districts, countries and landmarks all work, for example \"New York\", \"Paris\", \"Austin, Texas\" or \"Shibuya, Tokyo\". Booking resolves the text itself, so no ids are needed.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Check-in date in YYYY-MM-DD format. Prices and availability are always tied to a date range. Leave empty to use a stay starting 30 days from the run date." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "Check-out date in YYYY-MM-DD format. Must be at least one night after check-in. Leave empty to use a two night stay." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 30, "type": "integer", "description": "Number of adults in the party. Affects which rooms and prices Booking returns.", "default": 2 }, "childrenAges": { "title": "Children ages", "type": "array", "description": "Age of each child travelling, for example [4, 9] for two children. Leave empty for an adults-only search.", "default": [] }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 30, "type": "integer", "description": "Number of rooms required.", "default": 1 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on the number of properties written to the dataset across all destinations. Booking limits any single search to roughly 1,100 unique properties, so to collect more than that split a large city into districts or price bands.", "default": 500 }, "sortBy": { "title": "Sort by", "enum": [ "popularity", "price", "review_score_and_price", "class_descending", "class_ascending", "distance_from_search", "bayesian_review_score" ], "type": "string", "description": "Result ordering. Booking's default relevance ranking is used when left empty." }, "currency": { "title": "Currency", "type": "string", "description": "Currency for all returned prices, as a 3 letter ISO code. Setting this explicitly is recommended, since an unset currency follows the exit IP of the proxy.", "default": "USD" }, "language": { "title": "Language", "type": "string", "description": "Booking language code used for text fields such as district names, meal plans and review score words.", "default": "en-us" }, "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." }, "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." }, "minReviewScore": { "title": "Minimum review score", "enum": [ "5", "6", "7", "8", "9" ], "type": "string", "description": "Only return properties whose guest review score is at least this value, on Booking's 10 point scale." }, "starRatings": { "title": "Star ratings", "type": "array", "description": "Only return properties with these star ratings. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Narrow results to these Booking property categories. This maps to Booking's own category filter, which is broader than an exact type match: selecting Apartments also returns aparthotels and serviced apartments that Booking labels as hotels. Filter on the propertyType column afterwards if you need an exact type. Leave empty for all.", "items": { "type": "string", "enum": [ "204", "201", "203", "208", "206", "213", "222", "209" ], "enumTitles": [ "Hotels", "Apartments", "Hostels", "Bed and breakfasts", "Resorts", "Villas", "Condos", "Guest houses" ] }, "default": [] }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Booking's search endpoint works from Apify datacenter proxy, so the default is fine and residential proxy is not required.", "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 } } } } } } } } } }