{ "openapi": "3.0.1", "info": { "title": "TripAdvisor Scraper", "description": "Give it a TripAdvisor restaurants or hotels list URL and get the places back as rows: rating, review count, price band, phone number, full address, coordinates and cuisine tags.", "version": "0.1", "x-build-id": "FBT546qMnZ9ncXk4w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~tripadvisor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-tripadvisor-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/s-r~tripadvisor-scraper/runs": { "post": { "operationId": "runs-sync-s-r-tripadvisor-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/s-r~tripadvisor-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-tripadvisor-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": { "url": { "title": "Restaurants or hotels list URL", "type": "string", "description": "A TripAdvisor list page for one city, for example https://www.tripadvisor.com/Restaurants-g60745-Boston_Massachusetts.html or https://www.tripadvisor.com/Hotels-g60745-Boston_Massachusetts-Hotels.html. Returns one row per place with rating, review count, price band, phone, address and coordinates. Leave this empty and fill Review page URLs instead to collect review text." }, "detail_urls": { "title": "Review page URLs", "type": "array", "description": "Individual place pages to collect reviews from, for example https://www.tripadvisor.com/Restaurant_Review-g60745-d321583-Reviews-Boston_Sail_Loft-Boston_Massachusetts.html. Restaurant, hotel and attraction pages all work. Each URL returns the reviews its page carries, which is 10 to 15, newest first, with the full text, the reviewer, the rating, the visit month, the written date and any owner reply. Filling this switches the run to review collection and ignores the list URL.", "default": [], "items": { "type": "string" } }, "max_reviews_per_url": { "title": "Max reviews per URL", "minimum": 0, "maximum": 50, "type": "integer", "description": "Cap on reviews taken from each page. 0 means take every review the page carries. TripAdvisor does not honour review paging for this actor's access route, so a page yields 10 to 15 reviews and a higher number here cannot produce more.", "default": 0 }, "include_place_row": { "title": "Also return a row for each place", "type": "boolean", "description": "Adds one row per review URL describing the place itself (name, rating, total review count, address, coordinates, price band) ahead of its reviews. The place name is read from the page TripAdvisor actually served, not from the address you supplied.", "default": false }, "domain": { "title": "TripAdvisor site", "enum": [ "com", "co.uk", "fr", "de", "es", "it", "nl", "ca", "com.au", "in" ], "type": "string", "description": "Which national TripAdvisor site to read. This changes the language of the review text and the currency symbol of the price band. The place itself and its rating are the same on every site.", "default": "com" }, "limit": { "title": "Max places from the list URL", "minimum": 1, "maximum": 600, "type": "integer", "description": "How many places to return from a list URL, across as many pages as that takes. TripAdvisor puts 30 places on a page. Ignored when collecting reviews.", "default": 60 }, "retries": { "title": "Retries per page", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many times to re-request a page that came back refused or short before giving up on it and recording the reason.", "default": 3 } } }, "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 } } } } } } } } } }