{ "openapi": "3.0.1", "info": { "title": "TripAdvisor Reviews Scraper", "description": "Effortlessly extract chosen places on Tripadvisor. Extract the review text, URL, rating, date of travel, published date, basic reviewer info, owner's response, helpful votes, images, review language, place details. Download reviews in XML, JSON, CSV.", "version": "0.0", "x-build-id": "b9Fb5KBQvyRQ3vBjO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crucial_binoculars~TripAdvisor-Reviews-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crucial_binoculars-TripAdvisor-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/crucial_binoculars~TripAdvisor-Reviews-Scraper/runs": { "post": { "operationId": "runs-sync-crucial_binoculars-TripAdvisor-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/crucial_binoculars~TripAdvisor-Reviews-Scraper/run-sync": { "post": { "operationId": "run-sync-crucial_binoculars-TripAdvisor-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": "Start URLs", "type": "array", "description": "One or more TripAdvisor property URLs (hotels, restaurants, attractions). Each URL must contain the property ID in the format -d{id}-.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviews": { "title": "Limit reviews for each place", "minimum": 0, "type": "integer", "description": "Maximum number of reviews to scrape per property. Set to 0 for unlimited." }, "scrapeReviewerInfo": { "title": "Scrape reviewer info", "type": "boolean", "description": "Include reviewer profile details (name, avatar, location, contribution count) in the output.", "default": true }, "sinceDate": { "title": "Only reviews since date", "type": "string", "description": "Only return reviews published on or after this date (YYYY-MM-DD). Leave empty for all dates." }, "reviewRatings": { "title": "Review ratings", "uniqueItems": true, "type": "array", "description": "Filter by star rating. Leave empty to include all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "languages": { "title": "Reviews languages", "uniqueItems": true, "type": "array", "description": "Filter reviews by language. Leave empty to include all languages.", "items": { "type": "string", "enum": [ "en", "fr", "de", "es", "it", "pt", "nl", "ru", "ja", "zh", "ar", "ko", "pl", "sv", "tr" ], "enumTitles": [ "English", "French", "German", "Spanish", "Italian", "Portuguese", "Dutch", "Russian", "Japanese", "Chinese", "Arabic", "Korean", "Polish", "Swedish", "Turkish" ] }, "default": [] }, "sortBy": { "title": "Sort reviews by", "enum": [ "DATE_OF_STAY_DESCENDING", "DATE_OF_STAY_ASCENDING", "POPULARITY", "QUALITY" ], "type": "string", "description": "Sort order for reviews.", "default": "DATE_OF_STAY_DESCENDING" }, "includeImages": { "title": "Include review photos", "type": "boolean", "description": "Extract photo URLs attached to reviews.", "default": true }, "includeHotelResponses": { "title": "Include management responses", "type": "boolean", "description": "Extract owner/management responses to reviews.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings to reduce blocking risk. Recommended for large scrapes." }, "pageDelay": { "title": "Delay between pages (ms)", "minimum": 500, "maximum": 15000, "type": "integer", "description": "Delay in milliseconds between paginated API requests. Higher = safer but slower.", "default": 2000 }, "concurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of properties to scrape in parallel. Keep at 1–2 to avoid blocks.", "default": 2 }, "debugMode": { "title": "Debug mode", "type": "boolean", "description": "Enable verbose logging for troubleshooting.", "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 } } } } } } } } } }