{ "openapi": "3.0.1", "info": { "title": "Airbnb Reviews Scraper - Keyword Search & Topic Filters", "description": "Scrape Airbnb guest reviews with ratings, dates, host replies, translations, keyword search, topic filters and listing sub-ratings. Export CSV, Excel, JSON or XML.", "version": "0.1", "x-build-id": "EoHjCEBYlaIOZZ93f" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~airbnb-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-airbnb-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/parseforge~airbnb-reviews-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-airbnb-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/parseforge~airbnb-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-airbnb-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": "Airbnb listing URLs", "type": "array", "description": "Links to Airbnb listings on any Airbnb domain, for example https://www.airbnb.com/rooms/12937 or https://www.airbnb.co.uk/rooms/29542473.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingIds": { "title": "Listing IDs", "type": "array", "description": "Numeric Airbnb listing IDs (the number after /rooms/). Use this or the URL list, or both.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many reviews from each listing, so several listings share the Max Items budget. Leave empty to take every review." }, "sortBy": { "title": "Sort reviews by", "enum": [ "MOST_RECENT", "BEST_QUALITY", "RATING_DESC", "RATING_ASC" ], "type": "string", "description": "Order in which reviews are collected.", "default": "MOST_RECENT" }, "searchQuery": { "title": "Keyword search", "type": "string", "description": "Only reviews that mention this word or phrase, using Airbnb's own review search (for example: subway, noise, parking)." }, "reviewTopic": { "title": "Review topic", "enum": [ "ACCESS", "ACCURACY", "AIR_CONDITIONING", "AMENITIES", "BATHROOM", "BEACH", "BREAKFAST", "CHECK_IN", "CHECKOUT", "CLEANLINESS", "COMFORT", "CONDITION", "DECOR", "FAMILY", "GETTING_AROUND", "HOSPITALITY", "HOT_TUB", "INDOOR_SPACES", "KITCHEN", "LOCATION", "NEARBY", "NOISE", "OUTDOOR_SPACES", "POOL", "QUIET", "SLEEP", "SOLO_TRAVEL", "VALUE", "VIEW", "WALKABILITY" ], "type": "string", "description": "Only reviews Airbnb files under this topic. Topics differ by listing; a listing without the chosen topic returns no reviews and is reported in the log." }, "onlyReviewsNewerThan": { "title": "Only reviews newer than", "type": "string", "description": "Keep reviews written on or after this date (YYYY-MM-DD) or within a relative window such as 30 days or 6 months. With Most recent sorting the run stops paging as soon as it reaches older reviews." }, "minRating": { "title": "Minimum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only reviews with at least this many stars (1-5). Reviews without a star rating are skipped when this is set." }, "maxRating": { "title": "Maximum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep only reviews with at most this many stars (1-5). Set 3 to collect complaints only." }, "locale": { "title": "Language", "enum": [ "en-US", "az-AZ", "id-ID", "bs-BA", "ca-ES", "cs-CZ", "sr-ME", "da-DK", "de-DE", "de-AT", "de-CH", "de-LU", "et-EE", "en-AU", "en-CA", "en-GB", "en-GY", "en-IN", "en-IE", "en-NZ", "en-SG", "en-AE", "es-AR", "es-BZ", "es-BO", "es-CL", "es-CO", "es-CR", "es-EC", "es-SV", "es-ES", "es-US", "es-GT", "es-HN", "es-419", "es-MX", "es-NI", "es-PA", "es-PY", "es-PE", "es-VE", "fr-BE", "fr-CA", "fr-FR", "fr-CH", "fr-LU", "ga-IE", "hr-HR", "xh-ZA", "zu-ZA", "is-IS", "it-IT", "it-CH", "sw-XX", "lv-LV", "lt-LT", "hu-HU", "mt-MT", "ms-MY", "nl-BE", "nl-NL", "no-NO", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "sq-AL", "sk-SK", "sl-SI", "sr-RS", "fi-FI", "sv-SE", "tl-PH", "vi-VN", "tr-TR", "el-GR", "bg-BG", "mk-MK", "ru-RU", "uk-UA", "ka-GE", "hy-AM", "he-IL", "ar-XX", "hi-IN", "th-TH", "ko-KR", "ja-JP", "zh-US", "zh-CN", "zh-HK", "zh-TW" ], "type": "string", "description": "Reviews written in another language come back translated into this one (original text is always kept too). Relative dates and reviewer locations follow it as well.", "default": "en-US" }, "includeListingDetails": { "title": "Include listing details", "type": "boolean", "description": "Add the listing name, property type, location, coordinates, overall rating and the six category ratings (cleanliness, accuracy, check-in, communication, location, value) to every review.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Airbnb's review API is open, so no proxy is needed for normal runs. Switch Apify Proxy on for very large jobs.", "default": { "useApifyProxy": 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 } } } } } } } } } }