{ "openapi": "3.0.1", "info": { "title": "Airbnb Reviews Scraper — Ratings, Topics & Sentiment", "description": "Extract Airbnb reviews from listing URLs or IDs, including text, ratings, reviewer/host details, host replies, dates, media, topic filters, full-text search, and optional AI sentiment/translation.", "version": "0.1", "x-build-id": "buWpAFcMIEjdKueGi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~airbnb-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-airbnb-reviews", "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/automation-lab~airbnb-reviews/runs": { "post": { "operationId": "runs-sync-automation-lab-airbnb-reviews", "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/automation-lab~airbnb-reviews/run-sync": { "post": { "operationId": "run-sync-automation-lab-airbnb-reviews", "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": "Listing URLs", "type": "array", "description": "Enter one or more Airbnb listing URLs (e.g. https://www.airbnb.com/rooms/38618607).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingIds": { "title": "Listing IDs", "type": "array", "description": "Enter numeric Airbnb listing IDs (e.g. 12937). Use this instead of URLs if you already have listing IDs.", "items": { "type": "string" } }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 0, "type": "integer", "description": "Limit the number of reviews scraped per listing. Set to 0 for all reviews.", "default": 0 }, "sortBy": { "title": "Sort reviews by", "enum": [ "MOST_RECENT", "BEST_QUALITY", "RATING_DESC", "RATING_ASC" ], "type": "string", "description": "Choose how reviews are sorted before scraping.", "default": "MOST_RECENT" }, "filterByTopic": { "title": "Filter by topic", "enum": [ "", "GETTING_AROUND", "HOSPITALITY", "LOCATION", "BATHROOM", "SLEEP", "DECOR", "OUTDOOR_SPACE", "KITCHEN", "AMENITIES", "CLEANLINESS", "FOOD_AND_DINING", "NOISE_LEVEL", "CHECK_IN", "COMMUNICATION", "FAMILY_FRIENDLY", "PET_FRIENDLY", "WORK_FRIENDLY", "SAFETY", "ACCESSIBILITY" ], "type": "string", "description": "Only scrape reviews related to a specific topic (Airbnb AI-generated tags)." }, "searchQuery": { "title": "Search within reviews", "type": "string", "description": "Full-text search — only return reviews matching this text." }, "dateFrom": { "title": "Reviews from date", "type": "string", "description": "Only keep reviews created on or after this date: YYYY-MM-DD (e.g. 2025-01-01) or an age such as \"30 days\", \"2 weeks\" or \"6 months\" for scheduled monitoring. With \"Most recent\" sorting the scraper stops paging at the first older review, so it is fast. Reviews outside the range are not charged." }, "dateTo": { "title": "Reviews up to date", "type": "string", "description": "Only keep reviews created on or before this date (YYYY-MM-DD, inclusive) or an age such as \"7 days\". Leave empty for no upper limit." }, "locale": { "title": "Language", "enum": [ "en-US", "en-GB", "de-DE", "fr-FR", "es-ES", "it-IT", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "zh-TW", "nl-NL", "pl-PL", "ru-RU" ], "type": "string", "description": "Language for localized dates and labels.", "default": "en-US" }, "enableAIAnalysis": { "title": "Enable AI analysis", "type": "boolean", "description": "Add AI-powered sentiment analysis and English translations for non-English reviews. No API key needed, no extra cost. Adds sentiment, sentimentScore, aiTopics, and translatedText fields to each review. Increases run time.", "default": false } } }, "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 } } } } } } } } } }