{ "openapi": "3.0.1", "info": { "title": "Tripadvisor Reviews Scraper: Hotels, Restaurants, Tours", "description": "Scrape Tripadvisor reviews from URLs, place names or whole cities: original text and English translation, rating, dates, trip type, sub-ratings, photos, owner responses and reviewer hometown. Filter by rating, language, traveler type and date, or get only new reviews. $0.50 per 1,000.", "version": "0.0", "x-build-id": "es2P4OCOKTSKdZyvf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/epicscrapers~tripadvisor-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-epicscrapers-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/epicscrapers~tripadvisor-reviews-scraper/runs": { "post": { "operationId": "runs-sync-epicscrapers-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/epicscrapers~tripadvisor-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-epicscrapers-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": "Tripadvisor URLs", "type": "array", "description": "One per line, from any Tripadvisor country site. A hotel, restaurant, attraction or tour page (or one of its review pages) gives that place's reviews. A city list such as https://www.tripadvisor.com/Restaurants-g187147-Paris_Ile_de_France.html gives reviews of its top places. A location ID such as 1890933 works too.", "items": { "type": "string" } }, "searchQueries": { "title": "Place names", "type": "array", "description": "Find places by name instead of URL, e.g. \"Bellagio Las Vegas\" or \"Louvre Museum\". Add the city to pick the right one. The best match is used; the log shows what each name matched.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Collect reviews of the top places in a city or region, e.g. \"Rome\" or \"Lake Como\". Choose the place types and how many places below.", "items": { "type": "string" } }, "placeTypes": { "title": "Place types (for cities)", "type": "array", "description": "Which places to take from cities and city URLs such as Tourism-g187147. A list URL like Hotels-g… always uses its own type.", "items": { "type": "string", "enum": [ "hotels", "restaurants", "attractions", "tours" ], "enumTitles": [ "Hotels", "Restaurants", "Attractions", "Tours & activities" ] }, "default": [ "hotels", "restaurants", "attractions" ] }, "maxPlacesPerCity": { "title": "Max places per city and type", "minimum": 1, "maximum": 3000, "type": "integer", "description": "For cities and city URLs: how many places of each type, in Tripadvisor's order.", "default": 10 }, "maxReviewsPerPlace": { "title": "Max reviews per place", "minimum": 0, "type": "integer", "description": "Stop after this many reviews per place (newest first). Set to 0 to collect every review.", "default": 100 }, "onlyNewReviews": { "title": "Only new reviews (for repeat runs)", "type": "boolean", "description": "Remember which reviews earlier runs saw and return only reviews published since then. Turn it on in a saved task or schedule: the first run collects reviews as usual, every later run returns only the new ones, and you pay only for those.", "default": false }, "newerThan": { "title": "Only reviews published after", "pattern": "^(\\s*|\\d{4}-\\d{2}-\\d{2}.*|\\s*\\d+\\s*(day|week|month|year)s?(\\s+ago)?\\s*)$", "type": "string", "description": "A date (2026-01-31) or an age (7 days, 3 months, 1 year). Leave empty for all dates." }, "ratings": { "title": "Ratings", "type": "array", "description": "Only reviews with these ratings. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 - Terrible", "2 - Poor", "3 - Average", "4 - Very good", "5 - Excellent" ] }, "default": [] }, "languages": { "title": "Review languages", "type": "array", "description": "Language codes, e.g. en, it, fr, de, es, ja, zh. Leave empty for reviews in every language.", "default": [], "items": { "type": "string" } }, "tripTypes": { "title": "Traveler types", "type": "array", "description": "Only reviews from these kinds of trips. Leave empty for all.", "items": { "type": "string", "enum": [ "business", "couples", "family", "friends", "solo" ], "enumTitles": [ "Business", "Couples", "Family", "Friends", "Solo" ] }, "default": [] }, "keywords": { "title": "Only reviews mentioning", "type": "array", "description": "Keep only reviews whose title or text contains at least one of these words or phrases (not case-sensitive), e.g. breakfast, noise, staff. Leave empty for all.", "default": [], "items": { "type": "string" } }, "includeReviewerDetails": { "title": "Include reviewer details", "type": "boolean", "description": "Reviewer name, username, ID, profile link, hometown and avatar. Turn off to leave these fields empty, e.g. if you have no lawful basis to process personal data.", "default": true }, "loadOriginalText": { "title": "Load original text of translated reviews", "type": "boolean", "description": "Tripadvisor serves its English translation in place of the original for reviews it has translated (mostly recent ones). On: title and text are always as written, and the English translation is in translatedTitle and translatedText (one extra request per page with translated reviews). Off: those reviews keep only the English translation in title and text, marked with isMachineTranslated; language still shows the language they were written in.", "default": 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 } } } } } } } } } }