{
  "openapi": "3.0.1",
  "info": {
    "title": "Tripadvisor Reviews Scraper - Hotels & Restaurants",
    "description": "Get Tripadvisor reviews for any hotel, restaurant or attraction: text, star rating, date, trip date, sub-ratings, photos, owner responses and reviewer info. Paste URLs or search \"hotels in Lisbon\". Filter by stars, traveler type, month, language or date. No blocking, no proxies.",
    "version": "1.0",
    "x-build-id": "PVYhxj3MUegK10hOa"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/wrenfield-data~tripadvisor-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-wrenfield-data-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/wrenfield-data~tripadvisor-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-wrenfield-data-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/wrenfield-data~tripadvisor-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-wrenfield-data-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": {
          "startUrls": {
            "title": "Tripadvisor URLs",
            "type": "array",
            "description": "Tripadvisor pages of hotels, restaurants, attractions, tours or vacation rentals, e.g. <code>https://www.tripadvisor.com/Hotel_Review-g60763-d93437-Reviews-Hotel_Edison_Times_Square-New_York_City_New_York.html</code>. Any Tripadvisor country site works (.co.uk, .de, .fr...). A single-review link also works: the Actor takes the place it belongs to.",
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Search queries",
            "type": "array",
            "description": "Find places by keyword instead of URL, e.g. <code>hotels in Lisbon, Portugal</code>, <code>sushi restaurants in Austin, TX</code> or <code>museums in Rome</code>. The Actor takes the top places from Tripadvisor search and gets their reviews. Write \"... in City, Country\" or fill in <i>Search location</i> below.",
            "items": {
              "type": "string"
            }
          },
          "searchLocation": {
            "title": "Search location",
            "type": "string",
            "description": "Optional location used for every search query: <code>City, Country</code> (e.g. <code>Lisbon, Portugal</code>), <code>City, State</code> (e.g. <code>Portland, Maine</code>) or a region. Leave empty to read it from each query (\"hotels in Lisbon\")."
          },
          "maxPlacesPerSearch": {
            "title": "Max places per search",
            "minimum": 1,
            "maximum": 210,
            "type": "integer",
            "description": "How many top Tripadvisor search results (places) to take for each search query.",
            "default": 5
          },
          "maxReviewsPerPlace": {
            "title": "Max reviews per place",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum number of reviews to get for each place. Set <code>0</code> to get only place details (name, address, rating, review count and star distribution) without reviews.",
            "default": 100
          },
          "sortBy": {
            "title": "Sort reviews by",
            "enum": [
              "most_recent",
              "detailed_reviews",
              "relevance"
            ],
            "type": "string",
            "description": "Order in which reviews are collected. With a limit, this decides which reviews you get.",
            "default": "most_recent"
          },
          "reviewsNewerThan": {
            "title": "Only reviews newer than",
            "type": "string",
            "description": "Only reviews published on or after this date, e.g. <code>2026-09-01</code> or <code>30 days</code>. Great for scheduled monitoring: run daily or weekly and get only new reviews."
          },
          "ratings": {
            "title": "Star ratings",
            "type": "array",
            "description": "Only reviews with these star ratings, e.g. 1 and 2 to collect complaints. Empty = all ratings.",
            "items": {
              "type": "string",
              "enum": [
                "5",
                "4",
                "3",
                "2",
                "1"
              ],
              "enumTitles": [
                "5 - Excellent",
                "4 - Very good",
                "3 - Average",
                "2 - Poor",
                "1 - Terrible"
              ]
            }
          },
          "travelerTypes": {
            "title": "Traveler types",
            "type": "array",
            "description": "Only reviews from these types of travelers (mainly hotels and attractions). Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "families",
                "couples",
                "solo",
                "business",
                "friends"
              ],
              "enumTitles": [
                "Families",
                "Couples",
                "Solo",
                "Business",
                "Friends"
              ]
            }
          },
          "visitMonths": {
            "title": "Months of visit",
            "type": "array",
            "description": "Only reviews from trips in these months (seasonality analysis). Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "january",
                "february",
                "march",
                "april",
                "may",
                "june",
                "july",
                "august",
                "september",
                "october",
                "november",
                "december"
              ],
              "enumTitles": [
                "January",
                "February",
                "March",
                "April",
                "May",
                "June",
                "July",
                "August",
                "September",
                "October",
                "November",
                "December"
              ]
            }
          },
          "language": {
            "title": "Output language",
            "type": "string",
            "description": "Language to get reviews in, as a code: <code>en</code>, <code>fr</code>, <code>de</code>, <code>es</code>, <code>it</code>, <code>ja</code>, <code>zh-CN</code>... With translations on, Tripadvisor machine-translates reviews into this language where it can. Leave empty to use the language of the URL's site (English for tripadvisor.com). Every row keeps <code>originalLanguage</code>, so you can filter by the language reviews were written in."
          },
          "translateReviews": {
            "title": "Use Tripadvisor translations",
            "type": "boolean",
            "description": "When on, reviews written in other languages come in Tripadvisor's machine translation into the site's language (English for tripadvisor.com). <code>originalLanguage</code> and <code>isTranslated</code> tell you which ones were translated.",
            "default": true
          },
          "includePlaceDetails": {
            "title": "Add a place summary row",
            "type": "boolean",
            "description": "Also save one row per place (rowType = place) with name, address, rating, total review count, the 1-5 star distribution and, for searches, the search rank, category and price. Charged as a separate, small event.",
            "default": false
          },
          "includeReviewerInfo": {
            "title": "Include reviewer info",
            "type": "boolean",
            "description": "Include the reviewer's public display name, profile link, home location, review count and avatar. Turn off if you don't need personal data (recommended for GDPR-sensitive use).",
            "default": true
          },
          "maxItems": {
            "title": "Max reviews in total",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many reviews across all places. You can also cap spending with Apify's \"Maximum cost per run\"; the Actor stops exactly there and never buys data it cannot return."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}