{ "openapi": "3.0.1", "info": { "title": "Airbnb Review Scraper", "description": "Scrape Airbnb reviews from any listing with ease. This actor extracts reviewer names, dates, ratings, comments, and host responses. Ideal for market research, sentiment analysis, pricing strategy, and tracking guest experience trends.", "version": "0.1", "x-build-id": "fjz0taS5GeodI8E9k" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~airbnb-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-airbnb-review-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/scraper-engine~airbnb-review-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-airbnb-review-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/scraper-engine~airbnb-review-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-airbnb-review-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", "required": [ "startUrls" ], "properties": { "startUrls": { "title": "🔗 Airbnb Listing URLs or IDs", "type": "array", "description": "📥 One or more Airbnb listing URLs (https://www.airbnb.com/rooms/12937) or bare listing IDs (12937). Anything that is not an Airbnb listing is reported back as a clearly labelled row instead of being guessed at.", "items": { "type": "string" } }, "maxComments": { "title": "📊 Max Reviews Per Listing", "minimum": 1, "maximum": 10000, "type": "integer", "description": "🔢 How many reviews to collect from each listing. The only ceiling is the listing's own review count - a listing with 2,700 reviews can be read in full. Example: 10 listings x maxComments 50 = up to 500 rows. Default is 10.", "default": 10 }, "sortOrder": { "title": "↕️ Review Order", "enum": [ "MOST_RECENT", "RATING_DESC", "RATING_ASC", "BEST_QUALITY" ], "type": "string", "description": "🗂️ Which reviews come first. 'Newest first', 'Highest rated' and 'Lowest rated' are stable, so a long listing can be read from end to end without gaps. Airbnb's own relevance order is unstable and can return the same review more than once, which lowers coverage on long listings. Default is Newest first.", "default": "MOST_RECENT" }, "locale": { "title": "🌍 Review Language", "enum": [ "en", "az", "bs", "ca", "cs", "da", "de", "es", "et", "fr", "ga", "hr", "id", "sr", "xh", "zu" ], "type": "string", "description": "🗣️ The language Airbnb should localise the review text and dates into. Only languages that genuinely change the response are offered. Example: 'de' returns 'Dezember 2025' where 'en' returns '2 weeks ago'. Default is English.", "default": "en" }, "proxyConfiguration": { "title": "🌐 Connection Settings", "type": "object", "description": "🚦 Optional. The run manages its own connection by default and adapts if Airbnb slows it down.", "properties": { "useApifyProxy": { "title": "✅ Use Apify Proxy", "type": "boolean", "description": "🎛️ Route the run through Apify Proxy." }, "apifyProxyGroups": { "title": "🧩 Groups (optional)", "type": "array", "items": { "type": "string" }, "description": "🏷️ Optional. Leave empty to let the run choose." }, "apifyProxyCountry": { "title": "🌍 Country", "type": "string", "description": "📌 Optional ISO-2 country code, e.g. US, GB, CA." } } } } }, "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 } } } } } } } } } }