{ "openapi": "3.0.1", "info": { "title": "Tripadvisor Reviews Scraper", "description": "Tripadvisor reviews scraper API for any hotel, restaurant, attraction or tour: stars, title, text, date, trip type, photos, the owner's reply and the reviewer. Filter by stars, trip type, language, month or dates, and get the place's rating, ranking and address on every row.", "version": "0.2", "x-build-id": "lCHVeOyb5FMet2Zo0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~tripadvisor-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-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/dami_studio~tripadvisor-reviews-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-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/dami_studio~tripadvisor-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-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": { "startUrls": { "title": "Places", "type": "array", "description": "Tripadvisor links to hotels, restaurants, attractions or tours, one per line, from any Tripadvisor country site. A location id works too: 187591 or d187591 (the number after -d in the link).", "items": { "type": "string" } }, "maxReviewsPerPlace": { "title": "Reviews per place", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The most reviews to return for each place, 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 place. Leave it empty for no total limit." }, "searchResultsDatasetId": { "title": "Places from an earlier run", "type": "string", "description": "The id of a dataset whose rows carry Tripadvisor place links (a placeUrl, url or webUrl column) or location ids (locationId). Each place in it is read like the ones above." }, "sortBy": { "title": "Order", "enum": [ "mostRecent", "oldest", "detailed", "insightful", "tripadvisor" ], "type": "string", "description": "The order Tripadvisor lists the reviews in. With a date or \"Only new reviews\" set, the reviews always come newest first.", "default": "mostRecent" }, "ratings": { "title": "Star ratings", "type": "array", "description": "Only reviews with these ratings. Leave empty for every rating.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "tripTypes": { "title": "Trip types", "type": "array", "description": "Only reviews from these kinds of trip. Leave empty for all.", "items": { "type": "string", "enum": [ "family", "couples", "solo", "business", "friends" ], "enumTitles": [ "Family", "Couples", "Solo", "Business", "Friends" ] } }, "monthsWritten": { "title": "Months written", "type": "array", "description": "Only reviews written in these months, in 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" ] } }, "languages": { "title": "Languages", "type": "array", "description": "Only reviews in these languages. Reviews written in another language come machine-translated into them, unless \"Only the original language\" is ticked. A review comes once, in the first of your languages it is listed in. Leave empty for every review, some of them machine-translated into English. Each row says which.", "items": { "type": "string", "enum": [ "en", "fr", "de", "es", "it", "pt", "nl", "sv", "da", "no", "fi", "pl", "cs", "sk", "hu", "sr", "el", "tr", "ru", "ar", "iw", "ja", "ko", "zhCN", "zhTW", "th", "vi", "in" ], "enumTitles": [ "English", "French", "German", "Spanish", "Italian", "Portuguese", "Dutch", "Swedish", "Danish", "Norwegian", "Finnish", "Polish", "Czech", "Slovak", "Hungarian", "Serbian", "Greek", "Turkish", "Russian", "Arabic", "Hebrew", "Japanese", "Korean", "Chinese (Simplified)", "Chinese (Traditional)", "Thai", "Vietnamese", "Indonesian" ] } }, "originalLanguageOnly": { "title": "Only the original language", "type": "boolean", "description": "Leave out machine-translated reviews, so every review comes in the language it was written in.", "default": false }, "searchText": { "title": "Reviews mentioning", "type": "string", "description": "Only reviews that mention this word or phrase, as Tripadvisor's own review search finds them. Up to 100 characters." }, "reviewsSince": { "title": "Written since", "type": "string", "description": "Only reviews written on or after this date, written 2026-01-31, or a span back from today such as 30 days, 6 months or 1 year." }, "reviewsUntil": { "title": "Written until", "type": "string", "description": "Only reviews written on or before this date, written 2026-06-30." }, "monitoringStoreName": { "title": "Only new reviews: store name", "type": "string", "description": "Name a store, such as my-hotels, and each run returns only the reviews that earlier runs with the same name did not. The store is a key-value store in your own account, 3 to 63 letters, digits or dashes. Reviews then come newest first." }, "includePlaceDetails": { "title": "Place details", "type": "boolean", "description": "Add the place's own details to every row: its rating, review count by star, sub-ratings, ranking, address, position on the map, price range and cuisines.", "default": true }, "includeReviewerDetails": { "title": "Reviewer details", "type": "boolean", "description": "Add the reviewer's name, username, profile link, picture, hometown and number of contributions. Untick to leave them all out.", "default": true }, "flattenOutput": { "title": "Flat columns", "type": "boolean", "description": "Nested fields become one column each (place.rating, reviewer.name) and lists become text, which suits spreadsheets.", "default": false }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "How long to wait for one answer from Tripadvisor, from 5 to 60.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional: your own proxies. Runs work without them." } } }, "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 } } } } } } } } } }