{ "openapi": "3.0.1", "info": { "title": "My Personal Test Actor", "description": "This is my Test actor for Booking web scraper.", "version": "0.0", "x-build-id": "nc1oFrRLEz28rhl56" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/enchanted_clamp~my-actor-1/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-enchanted_clamp-my-actor-1", "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/enchanted_clamp~my-actor-1/runs": { "post": { "operationId": "runs-sync-enchanted_clamp-my-actor-1", "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/enchanted_clamp~my-actor-1/run-sync": { "post": { "operationId": "run-sync-enchanted_clamp-my-actor-1", "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": [ "proxyConfig" ], "properties": { "search": { "title": "Destination", "type": "string", "description": "Insert the destination name here" }, "maxPages": { "title": "Maximum number of result pages", "maximum": 1000000, "type": "integer", "description": "This is the maximum number of result pages you are going to extract. The higher the number, the longer the run will take. If you do not set a maximum number, it could take forever for the actor to finish its run." }, "simple": { "title": "Extract only basic information", "type": "boolean", "description": "Basic information includes property name and location. It does not include the property address and reviews.", "default": false }, "useFilters": { "title": "Get more than 1000 results", "type": "boolean", "description": "Booking.com has a limit of 1,000 results. Select to overcome this limit, but keep in mind the run will take much longer.", "default": false }, "startUrls": { "title": "Insert Booking.com URL", "type": "array", "description": "These are the Booking.com URLs you can scrape instead of the search term. It is better to use a simple URL and filter other options in filters here.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "destType": { "title": "Destination type", "enum": [ "city", "region" ], "type": "string", "description": "Choose type of destination", "default": "city" }, "propertyType": { "title": "Property type", "enum": [ "none", "Hotels", "Apartments", "Hostels", "Guest houses", "Homestays", "Bed and breakfasts", "Holiday homes", "Boats", "Villas", "Motels", "Holiday parks", "Campsites", "Luxury tents" ], "type": "string", "description": "Choose type of property", "default": "none" }, "sortBy": { "title": "Order results by", "enum": [ "upsort_bh", "price", "closest_ski_lift_distance", "class", "class_asc", "class_and_price", "distance_from_search", "bayesian_review_score" ], "type": "string", "description": "Hotel attribute by which the results will be ordered", "default": "distance_from_search" }, "minScore": { "title": "Minimum rating", "type": "string", "description": "Minimum rating of a hotel in \"8.4\" format" }, "currency": { "title": "Preferred currency", "enum": [ "ARS", "AUD", "AZN", "BHD", "BRL", "BGN", "CAD", "XOF", "CLP", "CNY", "COP", "CZK", "DKK", "EGP", "EUR", "FJD", "GEL", "HKD", "HUF", "INR", "IDR", "ILS", "JPY", "JOD", "KZT", "KRW", "KWD", "MYR", "MXN", "MDL", "NAD", "TWD", "NZD", "NOK", "OMR", "PLN", "GBP", "QAR", "RON", "RUB", "SAR", "SGD", "ZAR", "SEK", "CHF", "THB", "TRY", "AED", "USD", "UAH" ], "type": "string", "description": "Currency to be set on the website", "default": "USD" }, "language": { "title": "Language", "enum": [ "en-gb", "en-us", "de", "nl", "fr", "es", "es-ar", "ca", "it", "pt-pt", "pt-br", "no", "fi", "sv", "da", "cs", "hu", "ro", "ja", "zh-cn", "zh-tw", "pl", "el", "ru", "tr", "bg", "ar", "ko", "he", "lv", "uk", "id", "ms", "th", "et", "hr", "lt", "sk", "sr", "sl", "vi", "tl", "is" ], "type": "string", "description": "Language to be set on the website (does not apply to reviews)", "default": "en-us" }, "checkIn": { "title": "Check-in date (yyyy-mm-dd)", "type": "string", "description": "Check-in date", "default": "" }, "checkOut": { "title": "Check-out date (yyyy-mm-dd)", "type": "string", "description": "Check-out date", "default": "" }, "rooms": { "title": "Number of rooms", "maximum": 50, "type": "integer", "description": "", "default": 1 }, "adults": { "title": "Number of adults", "maximum": 50, "type": "integer", "description": "", "default": 2 }, "children": { "title": "Number of children", "maximum": 50, "type": "integer", "description": "", "default": 0 }, "minMaxPrice": { "title": "Price range", "type": "string", "description": "Insert the minimum and maximum price per night, e.g. 100-150." }, "maxReviews": { "title": "Maximum reviews", "maximum": 1000000, "type": "integer", "description": "Number of reviews to be scraped for each detail page. You can scrape up to 10 reviews without using any extra credits.", "default": 10 }, "scrapeReviewerName": { "title": "Include reviewer name", "type": "boolean", "description": "Extract reviewer name only if you have a legitimate reason to do so.", "default": false }, "proxyConfig": { "title": "Proxy configuration", "type": "object", "description": "Select the proxies you want to use (automatic Apify proxies/Residentials/your own).", "default": { "useApifyProxy": true } }, "testProxy": { "title": "Test proxies (useful for proxy groups with many blocked IPs, experimental)", "type": "boolean", "description": "Before the run, the crawler will try to find a proxy that's not blocked by Booking.com", "default": false }, "extendOutputFunction": { "title": "Extend output function", "type": "string", "description": "Function that takes a JQuery handle ($) as argument and returns data that will be merged with the default output" }, "debug": { "title": "Debugging mode", "type": "boolean", "description": "Select if you want to display debug logs.", "default": false } } }, "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 } } } } } } } } } }