{ "openapi": "3.0.1", "info": { "title": "TripAdvisor Reviews Scraper - Bulk Hotels, Restaurants", "description": "Bulk-pull every review from any TripAdvisor hotel, restaurant or attraction. Hand a list of TripAdvisor location IDs or URLs (up to 200 per run) and get every individual review as its own dataset row - no subscription, $0.0008 per review.", "version": "1.0", "x-build-id": "Sg5CnSzMjPEKKfVm5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jdtpnjtp~tripadvisor-reviews-bulk/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jdtpnjtp-tripadvisor-reviews-bulk", "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/jdtpnjtp~tripadvisor-reviews-bulk/runs": { "post": { "operationId": "runs-sync-jdtpnjtp-tripadvisor-reviews-bulk", "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/jdtpnjtp~tripadvisor-reviews-bulk/run-sync": { "post": { "operationId": "run-sync-jdtpnjtp-tripadvisor-reviews-bulk", "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", "required": [ "locations" ], "properties": { "locations": { "title": "TripAdvisor locations", "minItems": 1, "maxItems": 200, "uniqueItems": true, "type": "array", "description": "Up to 200 entries. Each entry is either a numeric TripAdvisor location_id (e.g. `1218720`) or a full TripAdvisor URL containing a `-d{ID}-` segment (Hotel_Review / Restaurant_Review / Attraction_Review). URLs and IDs can be mixed in one run.", "items": { "type": "string" } }, "maxReviewsPerLocation": { "title": "Max reviews per location", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap per location_id. The actor stops paginating each place once it has pushed this many review rows. Common values: 100 = sample, 500 = decent dataset, 5000 = deep crawl.", "default": 500 }, "language": { "title": "Review language", "type": "string", "description": "Language of reviews to keep. Pick **All languages** to keep every review, or a specific language to keep only reviews TripAdvisor tagged with it (others are skipped). You can also type any TripAdvisor language code (e.g. `cs`, `th`).", "default": "en" }, "sort": { "title": "Sort order", "enum": [ "most_relevant", "newest", "oldest", "highest", "lowest" ], "type": "string", "description": "Order in which TripAdvisor returns reviews. `most_relevant` matches the default web view; `newest` / `oldest` go strictly by date; `highest` / `lowest` go by rating.", "default": "most_relevant" }, "ratingFilter": { "title": "Star ratings to include", "uniqueItems": true, "type": "array", "description": "Keep only reviews with these star ratings. Leave empty to keep all. Tip: pick 1★ and 2★ to mine complaints, or 5★ for testimonials.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "★ 1 - Terrible", "★★ 2 - Poor", "★★★ 3 - Average", "★★★★ 4 - Very good", "★★★★★ 5 - Excellent" ] }, "default": [] }, "travelerType": { "title": "Traveler type", "enum": [ "", "families", "couples", "solo", "business", "friends" ], "type": "string", "description": "Restrict to reviews written by a specific traveler type. Leave blank for all.", "default": "" }, "textSearch": { "title": "Text search (within review body)", "type": "string", "description": "Optional substring filter applied server-side. Reviews not containing this text are skipped. Use for keyword mining (e.g. \"WiFi\", \"breakfast\", \"noise\").", "default": "" }, "stopOnLocationError": { "title": "Stop the whole run on the first location error", "type": "boolean", "description": "If true, the run aborts as soon as any one location_id fails (NOT_FOUND / UPSTREAM_BLOCKED / INVALID_INPUT). If false (default), failing locations are skipped with one diagnostic row and the run continues to the next location.", "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 } } }, "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 } } } } } } } } } }