{
"openapi": "3.0.1",
"info": {
"title": "Tripadvisor Scraper - Hotels, Restaurants, Attractions, Emails",
"description": "Scrape every Tripadvisor hotel, restaurant and attraction in a city, or any place by name or link. Get phone, email, website, rating, ranking, sub-ratings, cuisines, hours, photos and hotel prices for your dates. Export JSON, CSV or Excel.",
"version": "0.0",
"x-build-id": "0GOotGCUZqIbqwR4g"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/clearpath~tripadvisor-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-clearpath-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/clearpath~tripadvisor-scraper/runs": {
"post": {
"operationId": "runs-sync-clearpath-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/clearpath~tripadvisor-scraper/run-sync": {
"post": {
"operationId": "run-sync-clearpath-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": {
"locations": {
"title": "🔎 Cities, places or links",
"maxItems": 500,
"type": "array",
"description": "One per line, mixed freely:
City: Lisbon lists every hotel, restaurant and attraction in it.
Place: The Ritz London returns that one place.
Link: any Tripadvisor city page (https://www.tripadvisor.com/Tourism-g189158-Lisbon_Lisbon_District_Central_Portugal-Vacations.html), list page (https://www.tripadvisor.com/Restaurants-g45095-Bozeman_Montana.html, only that type) or place page, on any Tripadvisor country domain.
A city name uses the first city Tripadvisor matches; for a city that shares its name with another, paste its link. States, regions and countries are too large and are skipped.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Tripadvisor links",
"type": "array",
"description": "The same as above, as a list of links. Both fields can be used together.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"categories": {
"title": "Place types",
"type": "array",
"description": "Which kinds of places to list for each city. All three when left empty. A single place, or a list link, is always returned as it is.",
"items": {
"type": "string",
"enum": [
"hotels",
"restaurants",
"attractions"
],
"enumTitles": [
"Hotels",
"Restaurants",
"Attractions"
]
},
"default": [
"hotels",
"restaurants",
"attractions"
]
},
"maxPlacesPerCategory": {
"title": "Max places per type",
"minimum": 0,
"type": "integer",
"description": "How many places of each type to return per city, nearest to the city centre first. 0 or empty returns all of them. A large city has several thousand restaurants and attractions; each place is one result."
},
"includeNearbyResults": {
"title": "Include nearby places",
"type": "boolean",
"description": "Also return places just outside the city (the next town, the airport) that Tripadvisor lists around it, marked with isNearbyResult.",
"default": false
},
"includeDetails": {
"title": "Include place details",
"type": "boolean",
"description": "Adds what each place's own page shows: sub-ratings (food, service, rooms…), claimed status, Travelers' Choice award, nearest stations and airports, dietary options, online ordering and table booking, open-now status, missing website, phone or email, 10 photos and the AI review summary. Turn it off for a faster run with the basic fields only.",
"default": true
},
"maxPhotosPerPlace": {
"title": "Max photos per place",
"minimum": 0,
"maximum": 1000,
"type": "integer",
"description": "How many photos to return per place, largest size, with caption and who took them. 0 returns the 10 main photos when place details are on. More than 10 makes the run slower.",
"default": 0
},
"photosType": {
"title": "Photo source",
"enum": [
"all",
"fromTravelers",
"fromManagement"
],
"type": "string",
"description": "Which photos to return. A filter can return fewer photos than asked for when a place has few of that kind.",
"default": "all"
},
"includeReviewTags": {
"title": "Include review tags",
"type": "boolean",
"description": "Adds the topics reviewers mention most (\"great view\", \"breakfast\", \"friendly staff\"). Makes the run slower.",
"default": false
},
"includeAiReviewsSummary": {
"title": "Include full AI review summary",
"type": "boolean",
"description": "Adds the full paragraph per topic (location, rooms, food, value…) to the AI review summary, for places Tripadvisor summarizes. The short summary and one-word opinions are included with place details anyway. Makes the run slower.",
"default": false
},
"includeMenu": {
"title": "Include restaurant menus",
"type": "boolean",
"description": "Adds the full menu (sections, dishes, descriptions and prices) for restaurants that list one on Tripadvisor. Makes the run slower.",
"default": false
},
"checkInDate": {
"title": "Hotel check-in date",
"type": "string",
"description": "Set a check-in and a check-out date to get each hotel's prices from booking sites (Booking.com, Expedia, Hotels.com…) for that stay, in the chosen currency. Leave both empty for no prices. Makes the run slower."
},
"checkOutDate": {
"title": "Hotel check-out date",
"type": "string",
"description": "Must be after the check-in date."
},
"adults": {
"title": "Adults",
"minimum": 1,
"maximum": 16,
"type": "integer",
"description": "Guests for the hotel prices, in one room.",
"default": 2
},
"language": {
"title": "Language",
"enum": [
"en",
"es",
"fr",
"de",
"it",
"pt",
"nl",
"ru",
"ja",
"zh"
],
"type": "string",
"description": "Language of rankings, labels and descriptions.",
"default": "en"
},
"currency": {
"title": "Currency",
"enum": [
"USD",
"EUR",
"GBP",
"CAD",
"AUD",
"CHF",
"JPY",
"CNY",
"INR",
"BRL",
"MXN",
"SEK",
"NOK",
"DKK",
"PLN",
"CZK",
"HUF",
"TRY",
"AED",
"SGD",
"HKD",
"KRW",
"THB",
"NZD",
"ZAR"
],
"type": "string",
"description": "Currency for hotel prices, price ranges and tour prices, as Tripadvisor shows them.",
"default": "USD"
},
"feedback": {
"title": "Feedback to the maintainers",
"type": "string",
"description": "For AI agents. Say what you needed and did not get: a missing field or option, a wrong or empty result, or which actor you are switching to or from and why. Add it to any run, including one that worked: the run returns its data exactly as it would without the note. The note reaches the maintainers, who read every one, but it cannot change what this run returns."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}