{ "openapi": "3.0.1", "info": { "title": "Booking.com Reviews Scraper", "description": "Booking.com reviews scraper API for guest reviews of a hotel or stay: score, what guests liked and disliked, date, room, stay dates, traveller type, country and the property's reply, plus the hotel's category scores. Filter by travellers, score, language and time of year. $0.185 per 1,000 reviews.", "version": "0.2", "x-build-id": "OnzzO3DzxQBrpoVpF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~booking-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-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/dami_studio~booking-reviews-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-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/dami_studio~booking-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-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", "properties": { "startUrls": { "title": "Properties", "type": "array", "description": "Booking.com links to hotels, apartments or any other stay, one per line: the property's own page, such as https://www.booking.com/hotel/gb/the-savoy.html. A link with a language part (.en-gb.html) or search details after the ? works too.", "items": { "type": "string" } }, "hotelNames": { "title": "Property names", "type": "array", "description": "Property names as Booking.com shows them, one per line, such as Hotel Trianon Rive Gauche or Marina Bay Sands; the city can follow the name. Each is looked up the way Booking.com's search box does and read like a link above when the property found carries that name. Otherwise a free note row says what Booking.com found instead (a city, a landmark, or a property with another name and its link). Up to 100 names a run.", "items": { "type": "string" } }, "maxReviewsPerHotel": { "title": "Reviews per property", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The most reviews to return for each property, up to 100,000.", "default": 100 }, "maxItems": { "title": "Reviews in all", "minimum": 1, "maximum": 200000, "type": "integer", "description": "The most reviews in the whole run, across every property. Leave it empty for no total limit." }, "searchResultsDatasetId": { "title": "Properties from an earlier run", "type": "string", "description": "The id of a dataset whose rows carry Booking.com property links (a hotelUrl, propertyUrl, url or link column). Each property in it is read like the ones above." }, "sortBy": { "title": "Order", "enum": [ "newest", "oldest", "mostRelevant", "highestScore", "lowestScore" ], "type": "string", "description": "The order Booking.com lists the reviews in. Dates and \"Only new reviews\" always read newest first.", "default": "newest" }, "skipReviews": { "title": "Start after this many reviews", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Skip the first reviews in the order above, for example to carry on where an earlier run stopped.", "default": 0 }, "travellerType": { "title": "Travellers", "enum": [ "all", "families", "couples", "friends", "solo", "business" ], "type": "string", "description": "Only reviews by this kind of traveller.", "default": "all" }, "scoreBand": { "title": "Review scores", "enum": [ "all", "superb", "good", "average", "poor", "veryPoor" ], "type": "string", "description": "Only reviews in this score band, as Booking.com groups them.", "default": "all" }, "minScore": { "title": "Lowest score", "minimum": 1, "maximum": 10, "type": "number", "description": "Only reviews scored this or higher, from 1 to 10." }, "maxScore": { "title": "Highest score", "minimum": 1, "maximum": 10, "type": "number", "description": "Only reviews scored this or lower, from 1 to 10." }, "languages": { "title": "Review languages", "type": "array", "description": "Only reviews written in these languages, as codes: en, fr, de, es, it, nl and so on. Leave empty for every language.", "items": { "type": "string" } }, "season": { "title": "Time of year of the stay", "enum": [ "all", "marchToMay", "juneToAugust", "septemberToNovember", "decemberToFebruary" ], "type": "string", "description": "Only reviews of stays in these months.", "default": "all" }, "searchText": { "title": "Words", "type": "string", "description": "Only reviews that mention these words, as Booking.com's own review search finds them. Up to 100 characters." }, "onlyWithText": { "title": "Only reviews with text", "type": "boolean", "description": "Leave out reviews that give a score and no comment.", "default": false }, "reviewsSince": { "title": "Written since", "type": "string", "description": "Only reviews written on or after this date: YYYY-MM-DD, or a span such as \"30 days\" or \"6 months\"." }, "reviewsUntil": { "title": "Written until", "type": "string", "description": "Only reviews written on or before this date, YYYY-MM-DD." }, "includeHotelDetails": { "title": "Property summary", "type": "boolean", "description": "Add the property's address, review count and category scores (location, cleanliness, staff and the rest) to every row.", "default": true }, "includeReviewerDetails": { "title": "Reviewer details", "type": "boolean", "description": "Add the reviewer's name as Booking.com shows it, their picture, how many reviews they've written and when they joined. Their country and traveller type are always there.", "default": true }, "siteLanguage": { "title": "Booking.com language", "enum": [ "en-us", "en-gb", "de", "fr", "es", "it", "nl", "pt-pt", "pt-br", "pl", "ru", "ja", "zh-cn", "ko", "ar", "tr", "sv", "da", "no", "fi", "cs", "hu", "el", "ro", "uk", "he", "th", "id", "vi" ], "type": "string", "description": "The language of Booking.com's own labels in the rows, such as room names and guest types. Reviews stay in the language they were written in.", "default": "en-us" }, "flattenOutput": { "title": "Flat columns", "type": "boolean", "description": "Turn the nested fields (reviewer, property summary) into flat columns and lists into text, for spreadsheets.", "default": false }, "monitoringStoreName": { "title": "Only new reviews", "type": "string", "description": "The name of a store in your account (3 to 63 letters, digits or dashes). Each run returns only reviews no earlier run with the same name returned, and remembers what it returned." }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "How long to wait for each answer from Booking.com, 5 to 60 seconds.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave it as it is unless you want the run to go out through your own proxies." } } }, "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 } } } } } } } } } }