{ "openapi": "3.0.1", "info": { "title": "Tripadvisor Reviews Scraper", "description": "Scrape Tripadvisor reviews for attractions, hotels and restaurants by URL, ID or name. Get rating, title, full text, dates, trip type, author, hotel and restaurant sub-ratings, photos and owner responses. Filter by language, stars, date and trip type.", "version": "1.0", "x-build-id": "0ockMIC6bLvceBmXd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~tripadvisor-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-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/axlymxp~tripadvisor-reviews-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-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/axlymxp~tripadvisor-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-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", "properties": { "placeUrls": { "title": "Place URLs or IDs", "type": "array", "description": "Tripadvisor attraction, hotel or restaurant pages (…/Attraction_Review-…, …/Hotel_Review-…, …/Restaurant_Review-… on any Tripadvisor domain), or short IDs such as hotel:188730 / restaurant:719141 / attraction:188151.", "items": { "type": "string" } }, "searchQueries": { "title": "Search terms", "type": "array", "description": "Find places by name instead of URL, e.g. \"Hotel Plaza Athenee Paris\". The best matches are scraped (see Max places per search term).", "items": { "type": "string" } }, "placeTypes": { "title": "Place types for search terms", "type": "array", "description": "Which kinds of places a search term may resolve to.", "items": { "type": "string", "enum": [ "attraction", "hotel", "restaurant" ], "enumTitles": [ "Attractions", "Hotels", "Restaurants" ] }, "default": [ "attraction", "hotel", "restaurant" ] }, "maxPlacesPerQuery": { "title": "Max places per search term", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many of the best-matching places to scrape for each search term.", "default": 1 }, "maxReviewsPerPlace": { "title": "Max reviews per place", "minimum": 0, "type": "integer", "description": "Stop after this many reviews for each place. 0 = every review that matches the filters. You are charged per review.", "default": 100 }, "language": { "title": "Review language", "enum": [ "all", "en", "fr", "de", "es", "it", "pt", "nl", "ru", "ja", "ko", "zhCN", "zhTW", "ar", "tr", "pl", "sv", "da", "no", "fi", "el", "iw", "in", "th", "vi", "cs", "hu", "sk", "sr" ], "type": "string", "description": "Language of the reviews to collect. Tripadvisor's own default is English only, so \"All languages\" is the default here. With \"All languages\" or English, reviews written in other languages come back machine-translated to English by Tripadvisor (is_translated = true); pick a specific language to get the original text.", "default": "all" }, "ratings": { "title": "Star ratings", "type": "array", "description": "Only collect reviews with these ratings. Empty = all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "reviewsSince": { "title": "Reviews since (date)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only reviews written on or after this date, format YYYY-MM-DD. Handy for monitoring: schedule the actor and set this to the last run date." }, "tripTypes": { "title": "Trip types", "type": "array", "description": "Only reviews from these kinds of trips. Empty = all.", "items": { "type": "string", "enum": [ "Business", "Couples", "Family", "Friends", "Solo" ] } }, "publishedMonths": { "title": "Months written", "type": "array", "description": "Only reviews that were written (published) in these calendar months, any year. Useful for seasonality studies. Empty = all months.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12" ], "enumTitles": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ] } }, "concurrency": { "title": "Parallel places", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many places are scraped at the same time. Reviews inside one place are fetched page by page.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Datacenter proxy by default. If Tripadvisor blocks several exits in a row the run switches to Apify RESIDENTIAL automatically (charged as proxy traffic on your plan).", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }