{
  "openapi": "3.0.1",
  "info": {
    "title": "TripAdvisor Reviews Scraper",
    "description": "Scrape TripAdvisor reviews in bulk from any hotel, restaurant, or attraction: full text, ratings, subratings, photos, owner responses, plus the place's rating, star breakdown, and address. Filter by rating, traveler type, date, language, or keyword. Q&A and AI summaries too. $1 per 1,000 results.",
    "version": "0.0",
    "x-build-id": "4bOiSgUNCg0HVPdDe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sourabhbgp~tripadvisor-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sourabhbgp-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/sourabhbgp~tripadvisor-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sourabhbgp-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/sourabhbgp~tripadvisor-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sourabhbgp-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": {
          "startUrls": {
            "title": "TripAdvisor URLs",
            "type": "array",
            "description": "Hotel, restaurant, or attraction page URLs. Any TLD works (.com, .co.uk, .in, etc.).",
            "items": {
              "type": "string"
            }
          },
          "locationIds": {
            "title": "Location IDs",
            "type": "array",
            "description": "Numeric TripAdvisor location IDs (the number after the d in a URL). Use instead of or alongside URLs.",
            "items": {
              "type": "string"
            }
          },
          "maxReviews": {
            "title": "Max reviews per location",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum reviews to scrape per location. 0 means all available. If you omit this field entirely, the platform uses 50.",
            "default": 50
          },
          "sortReviewsBy": {
            "title": "Sort reviews by",
            "enum": [
              "newest",
              "detailed"
            ],
            "type": "string",
            "description": "newest returns the most recent reviews first. detailed uses TripAdvisor's detailed-review ordering.",
            "default": "newest"
          },
          "reviewRatings": {
            "title": "Filter by star rating",
            "type": "array",
            "description": "Only return reviews with these star ratings. Leave empty for all ratings.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5"
              ],
              "enumTitles": [
                "1 star",
                "2 stars",
                "3 stars",
                "4 stars",
                "5 stars"
              ]
            }
          },
          "reviewTripTypes": {
            "title": "Filter by traveler type",
            "type": "array",
            "description": "Only return reviews from these kinds of travelers. Leave empty for all. Reviews where the traveler did not say are only included when this is empty.",
            "items": {
              "type": "string",
              "enum": [
                "FAMILY",
                "COUPLES",
                "SOLO",
                "BUSINESS",
                "FRIENDS"
              ],
              "enumTitles": [
                "Families",
                "Couples",
                "Solo",
                "Business",
                "Friends"
              ]
            }
          },
          "reviewMonths": {
            "title": "Filter by month the review was posted",
            "type": "array",
            "description": "Only return reviews posted in these months. Leave empty for all months.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12"
              ],
              "enumTitles": [
                "January",
                "February",
                "March",
                "April",
                "May",
                "June",
                "July",
                "August",
                "September",
                "October",
                "November",
                "December"
              ]
            }
          },
          "reviewsPostedAfter": {
            "title": "Only reviews posted on or after",
            "type": "string",
            "description": "Keep only reviews posted on or after this date. Pick a date, or a period such as 7 days for scheduled runs that only need new reviews. Results come newest first when this is set."
          },
          "reviewLanguage": {
            "title": "Filter by review language",
            "type": "string",
            "description": "ISO 639-1 language code (for example en, fr, de, es). Returns reviews originally written in that language. Leave empty for all languages."
          },
          "reviewKeyword": {
            "title": "Filter by keyword",
            "type": "string",
            "description": "Keep only reviews that mention this word or phrase, the same as the review search box on TripAdvisor (for example: breakfast, rooftop, afternoon tea). TripAdvisor returns at most 1,000 matching reviews per search."
          },
          "includeQuestionsAndAnswers": {
            "title": "Include Questions and Answers",
            "type": "boolean",
            "description": "Also scrape the Q&A section for each location, including the answers to each question. If you omit this field entirely, it stays off.",
            "default": false
          },
          "maxQuestions": {
            "title": "Max questions per location",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum questions to scrape per location when Q&A is enabled. 0 means all.",
            "default": 50
          },
          "includeAiReviewSummary": {
            "title": "Include AI review summary",
            "type": "boolean",
            "description": "Also fetch TripAdvisor's AI-generated review summary for each location: an overall summary plus per-attribute breakdowns with cited review quotes. If you omit this field entirely, it stays off.",
            "default": false
          },
          "maxItems": {
            "title": "Max total items",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum total output rows across all locations (reviews, questions, and summaries combined). 0 means unlimited.",
            "default": 0
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 15,
            "type": "integer",
            "description": "How many locations to process in parallel.",
            "default": 8
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. Defaults to automatic Apify proxy routing.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}