{ "openapi": "3.0.1", "info": { "title": "TripAdvisor Review Scraper", "description": "TripAdvisor Review Scraper — Extract TripAdvisor reviews, ratings, review text, reviewer details, travel dates, photos, business information, and review URLs. Ideal for sentiment analysis, hospitality research, competitor analysis, and customer feedback monitoring.", "version": "0.3", "x-build-id": "Qi1Q5frnZL41694gf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fastdataapi~tripadvisor-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fastdataapi-tripadvisor-review-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/fastdataapi~tripadvisor-review-scraper/runs": { "post": { "operationId": "runs-sync-fastdataapi-tripadvisor-review-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/fastdataapi~tripadvisor-review-scraper/run-sync": { "post": { "operationId": "run-sync-fastdataapi-tripadvisor-review-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "🔗 TripAdvisor URLs or place names", "type": "array", "description": "One entry per place. Works for hotels, restaurants and attractions.\n\n**Direct TripAdvisor review links** give the best and fastest results, for example:\n- `https://www.tripadvisor.com/Hotel_Review-g60763-d208453-Reviews-Hilton_New_York_Times_Square-New_York_City_New_York.html`\n- `https://www.tripadvisor.com/Restaurant_Review-g60763-d25218867-Reviews-Shmone-New_York_City_New_York.html`\n- `https://www.tripadvisor.com/Attraction_Review-g60763-d105127-Reviews-Central_Park-New_York_City_New_York.html`\n\nLinks from any TripAdvisor country site (tripadvisor.co.uk, .de, .fr …) work too.\n\n**Place names or keywords** (e.g. `Hilton New York Times Square`) are looked up on Google and the first TripAdvisor page found is used, so they can miss. Duplicate entries and links to the same place are scraped once.", "items": { "type": "string" } }, "maxComments": { "title": "🔢 Maximum reviews per place", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many reviews to save from each place (1 to 10,000). If a place has fewer reviews matching your filters, you get all of them.\n\nFree plan: up to 20 reviews per place in each run and 200 reviews per month.", "default": 10 }, "sortOrder": { "title": "🔃 Sort order", "enum": [ "newest", "oldest", "relevant", "rating" ], "type": "string", "description": "The order in which reviews are collected.\n\n- **Newest first**: most recent reviews first (default, best for monitoring).\n- **Oldest first**: earliest reviews first. TripAdvisor doesn't offer this order at the moment, so the run uses newest first and says so in the log.\n- **Most relevant**: TripAdvisor gives the same order as newest first.\n- **Highest rating**: 5-star reviews first.", "default": "newest" }, "reviewsLanguages": { "title": "🌍 Review language", "enum": [ "ALL_REVIEW_LANGUAGES", "English", "Spanish", "French", "German", "Italian", "Portuguese", "Dutch", "Russian", "Japanese", "Korean", "Chinese (Simplified)", "Chinese (Traditional)", "Arabic", "Turkish", "Hebrew", "Swedish", "Norwegian", "Danish", "Finnish", "Polish", "Czech", "Hungarian", "Romanian", "Greek", "Thai", "Vietnamese", "Indonesian", "Malay", "Hindi" ], "type": "string", "description": "Only reviews written in this language are collected. Choose **All languages** to get every review of the place.", "default": "English" }, "reviewRatings": { "title": "🎯 Rating filter", "enum": [ "ALL_REVIEW_RATINGS", "POSITIVE", "NEGATIVE", "AVERAGE", "5", "4", "3", "2", "1" ], "type": "string", "description": "Only reviews with these star ratings are collected, so the review limit counts matching reviews only.\n\n- **All ratings**: every review (default).\n- **Positive**: 4 and 5 stars.\n- **Negative**: 1 and 2 stars.\n- **Average**: 3 stars.\n- Or one exact star rating.", "default": "ALL_REVIEW_RATINGS" }, "scrapeReviewerInfo": { "title": "👤 Include reviewer profile", "type": "boolean", "description": "Adds the reviewer's public profile to every row: name, username, profile link, home town, avatar and contribution counts. Turn it off when you only need the reviews; the `user` field is then `null`.", "default": true }, "reviewQueryId": { "title": "🔑 Review list ID (optional)", "type": "string", "description": "A 16-character value (digits 0-9 and letters a-f) that TripAdvisor uses to identify its review list. It changes from time to time; the Actor finds the current one by itself and remembers it for later runs, so you almost never need this. Set it only to pin a specific value, e.g. `ef3cb4f569f27e43`. An invalid value is ignored with a warning." }, "proxyConfiguration": { "title": "🌐 Proxy", "type": "object", "description": "Which connection the requests go through.\n\n- **Apify residential proxy** (default): the most reliable choice for TripAdvisor.\n- **Datacenter or your own proxies**: used for every request.\n- **No proxy**: the run starts on a direct connection and switches to Apify's residential proxy by itself if TripAdvisor starts blocking." } } }, "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 } } } } } } } } } }