{ "openapi": "3.0.1", "info": { "title": "Tripadvisor Scraper [Just 💰$0.41]", "description": "Scrape Tripadvisor hotels, restaurants and attractions for any city or place ID. Every record has name, rating, review total and link; hotels and restaurants add street address and GPS coordinates. Optional detail pages add phone and rating breakdown.", "version": "0.1", "x-build-id": "A361fEHdIAcViSzAb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~tripadvisor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-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/blackfalcondata~tripadvisor-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-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/blackfalcondata~tripadvisor-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-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": { "query": { "title": "🔍 Category", "type": "string", "description": "What to list. Accepted values: \"restaurants\", \"hotels\" or \"attractions\" (anything else ends the run with a message and no results). Use a JSON array (e.g. [\"restaurants\",\"hotels\"]) for several. Required if no Start URLs are provided." }, "location": { "title": "📍 Location", "type": "string", "description": "City, region or country to list places in (e.g. \"Boston\"), a Tripadvisor geo ID, or a Tripadvisor location URL. Required together with Category when no Start URLs are given. Use a JSON array for several locations." }, "maxResults": { "title": "💯 Max Results", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum total results (0 = unlimited). In incremental mode the actor watches the top-N ranked results (N = maxResults), so new places ranked beyond that window are not reported; raise maxResults for wider coverage.", "default": 100 }, "startUrls": { "title": "🔗 Start URLs", "type": "array", "description": "Tripadvisor list pages to scrape directly, one task per URL (results are merged and deduped). Supported: Hotels, Restaurants and Attractions pages with a location, e.g. https://www.tripadvisor.com/Restaurants-g60745-Boston_Massachusetts.html. When at least one URL is recognized, Start URLs replace the Category/Location fields.", "items": { "type": "string" }, "default": [] }, "includeDetails": { "title": "📋 Include Full Details", "type": "boolean", "description": "Open each place's page for extra fields: rating histogram, sub-ratings, owner status, neighborhood, email and full address.", "default": true }, "descriptionMaxLength": { "title": "✂️ Description Max Length", "minimum": 0, "type": "integer", "description": "Truncate description to N chars. 0 = no truncation.", "default": 0 }, "compact": { "title": "📦 Compact Output", "type": "boolean", "description": "Core fields only (for AI-agent/MCP workflows).", "default": false }, "descriptionFormat": { "title": "Description format", "enum": [ "all", "text", "html", "markdown" ], "type": "string", "description": "Pick a single description representation. `all` keeps every variant; `text` / `html` / `markdown` drop the others.", "default": "all" }, "excludeEmptyFields": { "title": "Exclude empty fields from output", "type": "boolean", "description": "Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.", "default": false }, "scrapeReviews": { "title": "💬 Scrape Reviews", "type": "boolean", "description": "Deliver each place's reviews as separate dataset rows (recordType \"review\"), one row per review, after the place rows. Reviews are read newest first.", "default": false }, "maxReviewsPerPlace": { "title": "🔢 Max Reviews per Place", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Most reviews to collect for each place (for each language when several languages are set). Used with Scrape Reviews.", "default": 20 }, "reviewRatings": { "title": "⭐ Only These Ratings", "type": "array", "description": "Collect only reviews with these star ratings. Leave empty for every rating.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "Terrible", "Poor", "Average", "Very good", "Excellent" ] }, "default": [] }, "reviewsLanguages": { "title": "🌐 Review Languages", "type": "array", "description": "Two-letter language codes (ISO 639-1, e.g. en, it, de). Each code gives its own pass over a place's reviews and includes Tripadvisor's machine translations into that language. Check originalLanguage and translationType on each review row to tell original text from translations. Leave empty for one unfiltered pass.", "items": { "type": "string" }, "default": [] }, "lastReviewDate": { "title": "📅 Reviews Since", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Stop collecting a place's reviews once they are older than this date. A date (YYYY-MM-DD, e.g. 2026-01-31) or a relative value such as \"30 days\", \"2 weeks\", \"3 months\" or \"1 year\". Leave empty for no cutoff." }, "scrapeReviewerInfo": { "title": "👤 Include Reviewer Info", "type": "boolean", "description": "Add the reviewer (name, profile, hometown, contribution counts) to each review row. Turn off to leave the user field empty.", "default": true }, "includeReviewTags": { "title": "🏷️ Include Review Tags", "type": "boolean", "description": "Add reviewTags to each place row: the theme phrases Tripadvisor lists for its reviews (e.g. \"pizza\", \"worth the wait\"). Opens each place's page.", "default": false }, "includeNearby": { "title": "📍 Include Nearby Places", "type": "boolean", "description": "Add nearby to each place row: the restaurants, hotels and attractions Tripadvisor lists nearby, with rating, review count, award and distance. The distance unit is not stated by Tripadvisor for every list (values are consistent with miles; distances Tripadvisor shows with a unit are converted to miles). Opens each place's page.", "default": false }, "incrementalMode": { "title": "♻️ Incremental Mode", "type": "boolean", "description": "Compare against previous run state. stateKey is optional — defaults to a value derived from search inputs (queries, locations, startUrls, country) so different filter sets never share state.", "default": false }, "stateKey": { "title": "🔑 State Key", "type": "string", "description": "Optional. Stable identifier for the tracked search universe. Leave empty to auto-generate from search inputs." }, "skipReposts": { "title": "🚫 Skip Reposts", "type": "boolean", "description": "When incremental, skip listings whose content matches an expired listing from a prior run (cross-run duplicate detection).", "default": false }, "emitUnchanged": { "title": "🔄 Emit Unchanged Listings", "type": "boolean", "description": "When incremental mode is on, also emit listings whose content has not changed since the last run.", "default": false }, "emitExpired": { "title": "⚰️ Emit Expired Listings", "type": "boolean", "description": "When incremental mode is on, also emit listings that were seen before but are no longer found.", "default": false }, "notifyOnlyChanges": { "title": "🔄 Notify Only New/Updated", "type": "boolean", "description": "When Incremental Mode is on, only send notifications for NEW and UPDATED listings. Has no effect outside incremental mode.", "default": false }, "notificationLimit": { "title": "📊 Max Listings Per Notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of listings included in each notification message (1–20).", "default": 5 }, "telegramToken": { "title": "🔑 Telegram Bot Token", "type": "string", "description": "Telegram bot token (from @BotFather). Required for Telegram notifications." }, "telegramChatId": { "title": "💬 Telegram Chat ID", "type": "string", "description": "Telegram chat or channel ID (e.g. \"-100123456789\"). Required when telegramToken is set." }, "discordWebhookUrl": { "title": "🎮 Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL. Server Settings → Integrations → Webhooks → New Webhook." }, "slackWebhookUrl": { "title": "💼 Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL. api.slack.com/messaging/webhooks." }, "whatsappPhoneNumberId": { "title": "📞 WhatsApp Phone Number ID", "type": "string", "description": "Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set." }, "whatsappAccessToken": { "title": "📱 WhatsApp Access Token", "type": "string", "description": "WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24h (service-conversation window — free since Nov 2024)." }, "whatsappTo": { "title": "📲 WhatsApp Recipient", "type": "string", "description": "Recipient phone in E.164 format without + (e.g. \"436641234567\"). Recipient must have messaged your business number within last 24h." }, "webhookUrl": { "title": "🪝 Generic Webhook URL", "type": "string", "description": "Receives a JSON POST with {metadata, items} after each run. Universal escape hatch for n8n / Make / Zapier / custom backends." }, "webhookHeaders": { "title": "📋 Webhook Headers", "type": "object", "description": "Optional JSON object of custom headers (e.g. {\"Authorization\":\"Bearer ...\"})." }, "appConnector": { "title": "Send results to a connected app", "type": "string", "description": "Optional. Pick a connected app under Settings → API & Integrations to receive your results (including any contact details). Best-effort across MCP connectors as Apify expands its catalog." }, "mcpIssueTeam": { "title": "Issue tracker team", "type": "string", "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one." }, "lat": { "title": "🌐 Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "GPS latitude. Pair with lon." }, "lon": { "title": "🌐 Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "GPS longitude. Pair with lat." }, "radiusKm": { "title": "📏 Search Radius (km)", "minimum": 0, "maximum": 500, "type": "integer", "description": "Search radius in kilometres around the given coordinates." } } }, "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 } } } } } } } } } }