{ "openapi": "3.0.1", "info": { "title": "Tripadvisor Reviews Scraper", "description": "Scrape Tripadvisor reviews of any hotel, restaurant, attraction or tour: rating, title, full text in the original language plus English, dates, trip type, sub-ratings, reviewer and owner response, plus the place's rating and address. No login.", "version": "0.1", "x-build-id": "EPrUdu9wtCOb64VtV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jmlp~tripadvisor-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jmlp-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/jmlp~tripadvisor-reviews-scraper/runs": { "post": { "operationId": "runs-sync-jmlp-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/jmlp~tripadvisor-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-jmlp-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": { "places": { "title": "Places", "type": "array", "description": "One per line: a Tripadvisor link to a hotel, restaurant, attraction or tour (from any country's Tripadvisor), its location id (d187591), or its name (The Ritz London). A name stands for every place Tripadvisor's search finds under it.", "items": { "type": "string" } }, "maxReviewsPerPlace": { "title": "Max reviews per place", "type": "integer", "description": "The newest this many reviews of each place. Empty means every review, back to the first." }, "ratings": { "title": "Ratings", "type": "array", "description": "Only reviews with these ratings. Empty means all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 - Terrible", "2 - Poor", "3 - Average", "4 - Very good", "5 - Excellent" ] } }, "languages": { "title": "Review languages", "type": "array", "description": "Only reviews written in these languages: codes or names (en, de, French). Empty means every language, each review in the language it was written in, with Tripadvisor's English translation alongside.", "items": { "type": "string" } }, "dateFrom": { "title": "Published since", "type": "string", "description": "Only reviews published on or after this date: 2025-01-01, or relative such as '30 days' or '6 months'. For daily or weekly runs that collect only what is new." }, "tripTypes": { "title": "Trip types", "type": "array", "description": "Only reviews from these kinds of trips. Empty means all.", "items": { "type": "string", "enum": [ "Business", "Couples", "Family", "Friends", "Solo" ] } }, "searchText": { "title": "Reviews mentioning", "type": "string", "description": "Only reviews that mention this word or phrase, as Tripadvisor's own review search finds them: breakfast, noise, rooftop." }, "maxReviews": { "title": "Max reviews in total", "type": "integer", "description": "Stop after this many reviews across every place. Caps both runtime and cost." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Tripadvisor answers residential exits. The default works; other settings fall back to it.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "resume": { "title": "Checkpoint progress", "type": "boolean", "description": "Save progress every ~30s so a run that gets migrated or restarted by the platform picks up where it stopped, without repeating reviews.", "default": true }, "continueFromLastRun": { "title": "Continue from last run", "type": "boolean", "description": "If your previous run with the same input was interrupted, scrape only what it missed. Reviews already collected stay in THAT run's dataset.", "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 }, "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 } } } } } } } } } }