{
  "openapi": "3.0.1",
  "info": {
    "title": "Tripadvisor Reviews Extractor",
    "description": "The TripAdvisor scraper is designed to extract review data using customizable queries and filters. Supports extraction of ratings, traveler types, review dates, and review content with multiple sorting options and keyword filtering for targeted data collection.",
    "version": "0.0",
    "x-build-id": "rvL3cBBBZb5Mak64W"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/mikolabs~tripadvisor-reviews-scraper-extractor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-mikolabs-tripadvisor-reviews-scraper-extractor",
        "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/mikolabs~tripadvisor-reviews-scraper-extractor/runs": {
      "post": {
        "operationId": "runs-sync-mikolabs-tripadvisor-reviews-scraper-extractor",
        "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/mikolabs~tripadvisor-reviews-scraper-extractor/run-sync": {
      "post": {
        "operationId": "run-sync-mikolabs-tripadvisor-reviews-scraper-extractor",
        "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": [
          "queries"
        ],
        "properties": {
          "queries": {
            "title": "🔎 Queries (Place URL or Place ID)",
            "type": "array",
            "description": "TripAdvisor URLs, numeric location IDs, or place names to resolve and scrape.",
            "items": {
              "type": "string"
            }
          },
          "reviewsPerPlace": {
            "title": "📄 Reviews Per Place",
            "minimum": 1,
            "type": "integer",
            "description": "Default limit is 100 reviews per query when Parse All Reviews is off. Clear this field to scrape all reviews even when Parse All Reviews is off.",
            "default": 100
          },
          "parseAllReviews": {
            "title": "♾️ Parse All Reviews",
            "type": "boolean",
            "description": "Scrape all available reviews instead of stopping at the per-place limit.",
            "default": false
          },
          "sortBy": {
            "title": "↕️ Sort By",
            "enum": [
              "most_recent",
              "detailed_reviews"
            ],
            "type": "string",
            "description": "TripAdvisor review ordering mode.",
            "default": "most_recent"
          },
          "ratingIs": {
            "title": "⭐ Ratings",
            "type": "array",
            "description": "Optional star ratings to keep.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5"
              ],
              "enumTitles": [
                "1 star",
                "2 stars",
                "3 stars",
                "4 stars",
                "5 stars"
              ]
            },
            "default": []
          },
          "travelerType": {
            "title": "👥 Traveler Type",
            "type": "array",
            "description": "Optional traveler types to keep.",
            "items": {
              "type": "string",
              "enum": [
                "business",
                "couples",
                "family",
                "friends",
                "solo"
              ],
              "enumTitles": [
                "Business",
                "Couples",
                "Family",
                "Friends",
                "Solo"
              ]
            },
            "default": []
          },
          "monthsOfVisit": {
            "title": "🗓️ Months Of Visit",
            "type": "array",
            "description": "Optional visit months filter.",
            "items": {
              "type": "string",
              "enum": [
                "jan",
                "feb",
                "mar",
                "apr",
                "may",
                "jun",
                "jul",
                "aug",
                "sep",
                "oct",
                "nov",
                "dec"
              ],
              "enumTitles": [
                "Jan",
                "Feb",
                "Mar",
                "Apr",
                "May",
                "Jun",
                "Jul",
                "Aug",
                "Sep",
                "Oct",
                "Nov",
                "Dec"
              ]
            },
            "default": []
          },
          "keyword": {
            "title": "📝 Keyword",
            "type": "string",
            "description": "Optional keyword to search for in review title or body.",
            "default": ""
          },
          "since": {
            "title": "📅 Since",
            "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "Keep only reviews on or after this date. Format: YYYY-MM-DD.",
            "default": ""
          },
          "lang": {
            "title": "🌐 Review Language",
            "type": "string",
            "description": "Optional TripAdvisor review language filter. Use a single code or comma-separated codes, such as en or en,fr.",
            "default": ""
          },
          "locale": {
            "title": "🧭 Locale",
            "enum": [
              "en-US",
              "en-CA",
              "fr-CA",
              "pt-BR",
              "es-MX",
              "es-AR",
              "es-CL",
              "es-CO",
              "es-PE",
              "es-VE",
              "en-GB",
              "it-IT",
              "es-ES",
              "de-DE",
              "fr-FR",
              "sv-SE",
              "nl-NL",
              "tr-TR",
              "da-DK",
              "en-IE",
              "de-AT",
              "el-GR",
              "nb-NO",
              "pt-PT",
              "ru-RU",
              "de-CH",
              "fr-CH",
              "it-CH",
              "fr-BE",
              "nl-BE",
              "ja-JP",
              "en-IN",
              "en-AU",
              "en-MY",
              "en-NZ",
              "en-PH",
              "en-SG"
            ],
            "type": "string",
            "description": "TripAdvisor locale used in GraphQL requests.",
            "default": "en-US"
          },
          "delaySeconds": {
            "title": "⏱️ Delay Seconds",
            "minimum": 0,
            "type": "number",
            "description": "Base delay between page requests.",
            "default": 1.2
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}