{ "openapi": "3.0.1", "info": { "title": "Booking.com Reviews Scraper", "description": "Scrape guest reviews from Booking.com hotel page URLs. Returns score, date, title, liked and disliked text, guest country, traveler type, room, nights, stay dates, photo count and owner reply. Filter by language, score, traveler type and date. Optional AI sentiment and topic tags.", "version": "0.0", "x-build-id": "jER0gDY5QvFqxEXTA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~booking-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-booking-reviews-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/axiomworks~booking-reviews-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-booking-reviews-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/axiomworks~booking-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-booking-reviews-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Hotel URLs", "type": "array", "description": "Booking.com hotel page URLs as objects, e.g. [{\"url\": \"https://www.booking.com/hotel/gb/the-savoy.html\"}]. Locale domains, language suffixes and query parameters are accepted. Hotel names are not accepted.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviewsPerHotel": { "title": "Max reviews per hotel", "minimum": 0, "type": "integer", "description": "Maximum number of reviews to collect for each hotel, e.g. 50. Use 0 to collect every available review. Default 50.", "default": 50 }, "maxItems": { "title": "Max items (total)", "type": "integer", "description": "Optional cap on the total number of reviews across all hotels, e.g. 100. Leave empty for no total cap." }, "sortBy": { "title": "Sort by", "enum": [ "MOST_RELEVANT", "NEWEST_FIRST", "OLDEST_FIRST", "SCORE_DESC", "SCORE_ASC" ], "type": "string", "description": "Order in which reviews are collected, e.g. 'NEWEST_FIRST'. Defaults to NEWEST_FIRST.", "default": "NEWEST_FIRST" }, "languageFilter": { "title": "Review language", "type": "string", "description": "Only return reviews written in this language, as a code such as 'en', 'de' or 'fr'. Leave empty for all languages." }, "travelerTypeFilter": { "title": "Traveler type", "description": "Only return reviews from one traveler type: 'FAMILIES', 'COUPLES', 'GROUP_OF_FRIENDS', 'SOLO_TRAVELLERS' or 'BUSINESS_TRAVELLERS' (case-insensitive; a string or one-item list, short forms also work)." }, "reviewScoreFilter": { "title": "Review score", "description": "Only return reviews in one score band: 'REVIEW_ADJ_SUPERB' (9+), 'REVIEW_ADJ_GOOD' (7-9), 'REVIEW_ADJ_AVERAGE_PASSABLE' (5-7), 'REVIEW_ADJ_POOR' (3-5) or 'REVIEW_ADJ_VERY_POOR' (1-3) (case-insensitive; a string or one-item list, short forms also work)." }, "minDate": { "title": "Oldest review date", "type": "string", "description": "Skip reviews written before this date, in YYYY-MM-DD format, e.g. '2025-01-01'. With NEWEST_FIRST sorting, paging stops at the first older review." }, "includeReviewsWithoutText": { "title": "Include score-only reviews", "type": "boolean", "description": "Also return reviews that have a score but no written title or comments. Off by default, so every returned review has text.", "default": false }, "enrichment": { "title": "AI enrichment", "type": "boolean", "description": "Add sentiment and topic labels to each review using a third-party AI processor. Off by default. Each enriched review is billed as an extra event on top of the per-review charge.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used to reach Booking.com. Apify Proxy (datacenter) is used by default, with automatic fallback to residential IPs if a page is blocked." } } }, "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 } } } } } } } } } }