{ "openapi": "3.0.1", "info": { "title": "Tripadvisor Reviews Scraper: Ratings, Replies, Translations", "description": "Tripadvisor reviews for hotel, restaurant and attraction URLs or place names: rating, text, date, owner reply, sub-ratings; $4.50 per 1,000 reviews. No depth limit, optional translation, Tripadvisor-side filters. Only-new mode, free error rows, no reviewer names.", "version": "0.1", "x-build-id": "X42gcvaduJaXok2Du" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arcadium~tripadvisor-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arcadium-tripadvisor-reviews", "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/arcadium~tripadvisor-reviews/runs": { "post": { "operationId": "runs-sync-arcadium-tripadvisor-reviews", "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/arcadium~tripadvisor-reviews/run-sync": { "post": { "operationId": "run-sync-arcadium-tripadvisor-reviews", "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": "Tripadvisor place URLs", "type": "array", "description": "Hotel, restaurant or attraction pages, e.g. https://www.tripadvisor.com/Hotel_Review-g60763-d93450-Reviews-Hyatt_Grand_Central_New_York-New_York_City_New_York.html. Any Tripadvisor domain works. Add this, search queries, or both.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search by name", "type": "array", "description": "Place names to look up, for example 'hyatt grand central new york'. The best match for each name is scraped. Use URLs when you need an exact place.", "items": { "type": "string" } }, "maxReviewsPerPlace": { "title": "Max reviews per place", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of reviews to collect for each place (up to 50,000)." }, "sort": { "title": "Sort order", "enum": [ "MOST_RECENT", "DETAILED", "INSIGHTFUL" ], "type": "string", "description": "Order of the reviews. Most recent is newest first and enables the date filter and the incremental mode.", "default": "MOST_RECENT" }, "ratings": { "title": "Ratings", "type": "array", "description": "Only reviews with these star ratings (1 to 5). Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "languages": { "title": "Review languages", "type": "array", "description": "Only reviews written in these languages, as two-letter codes such as en, de, fr. Leave empty for all languages. Each language is read in its own pass.", "items": { "type": "string" } }, "tripTypes": { "title": "Trip types", "type": "array", "description": "Only reviews from these kinds of travelers. Leave empty for all.", "items": { "type": "string", "enum": [ "BUSINESS", "COUPLES", "FAMILY", "FRIENDS", "SOLO" ], "enumTitles": [ "Business", "Couples", "Family", "Friends", "Solo" ] } }, "visitMonths": { "title": "Months of visit", "type": "array", "description": "Only reviews about visits in these months (any year). Leave empty for all.", "items": { "type": "string", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ], "enumTitles": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ] } }, "keyword": { "title": "Keyword", "type": "string", "description": "Only reviews that mention this word or phrase. Tripadvisor returns at most 1,000 matches for a keyword search. Example: breakfast." }, "translateTo": { "title": "Translate to", "type": "string", "description": "Language code (for example en). Reviews written in other languages get a machine translation in extras.translatedText next to the original text. Tripadvisor only translates reviews from roughly the last two years. Leave empty for originals only." }, "includePlaceSummary": { "title": "Add place rating and review count", "type": "boolean", "description": "Adds the place's overall rating and total review count to every row (product.rating, product.reviewCount). Costs five small extra requests per place; turn off if you only need the review text.", "default": true }, "dateFrom": { "title": "Reviews from date", "type": "string", "description": "Only keep reviews written on or after this date (YYYY-MM-DD, or a relative span such as 30 days or 2 months; empty = no filter). With the most recent sort, reading stops once reviews are older." }, "onlyNewReviews": { "title": "Only new reviews", "type": "boolean", "description": "Skip reviews delivered by earlier runs that used the same state key, and do not charge for them. Forces the most recent sort.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Name of the incremental state (letters, digits and dashes). Change it to start over. State is kept in a key-value store in your account. Example: weekly-monitoring.", "default": "default" }, "includeErrorRows": { "title": "Include error rows", "type": "boolean", "description": "Add one row per place that could not be read, with the reason. These rows are free.", "default": true }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times a failed request is retried.", "default": 3 }, "queryIdOverride": { "title": "Query id override (advanced)", "type": "string", "description": "Advanced: a 16 character hex id of the reviews query to try first. Leave empty; the actor finds a working id by itself." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Advanced: use your own proxy. By default the actor picks the cheapest tier that works." } } }, "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 } } } } } } } } } }