{ "openapi": "3.0.1", "info": { "title": "Airbnb Reviews Scraper — Ratings, Comments & Host Replies", "description": "Scrape all reviews for any Airbnb listing — rating, comment, date, reviewer, host response, photos, and topic tags. HTTP-only, MCP-ready.", "version": "0.1", "x-build-id": "uE3hFa0EE4UVzUxNu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~airbnb-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-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/khadinakbar~airbnb-reviews-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-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/khadinakbar~airbnb-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-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": { "listingUrls": { "title": "Airbnb listing URLs", "type": "array", "description": "List of Airbnb listing (room) page URLs to scrape reviews from (e.g. 'https://www.airbnb.com/rooms/20669368'). Accepts full URLs with or without query parameters; the room ID is extracted automatically. Use this OR 'Listing IDs' — provide at least one. This is NOT for search/results pages or experience URLs, only individual stay listings.", "items": { "type": "string" } }, "listingIds": { "title": "Listing IDs", "type": "array", "description": "Numeric Airbnb room IDs as an alternative to full URLs (e.g. '20669368'). Each ID is the number after '/rooms/' in a listing URL. Use this OR 'Airbnb listing URLs'. NOT a host ID, review ID, or experience ID — only stay-listing room IDs.", "items": { "type": "string" } }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 0, "type": "integer", "description": "Maximum number of reviews to scrape per listing, newest-first by default. Set to 0 to scrape ALL available reviews for each listing. Defaults to 100. Each scraped review is billed, so this also caps your cost per listing.", "default": 100 }, "sortBy": { "title": "Sort order", "enum": [ "MOST_RECENT", "RATING_DESC", "RATING_ASC" ], "type": "string", "description": "Order in which reviews are fetched. 'MOST_RECENT' returns newest first (default), 'RATING_DESC' highest-rated first, 'RATING_ASC' lowest-rated first. Affects which reviews you get when 'Max reviews per listing' is below the listing's total.", "default": "MOST_RECENT" }, "language": { "title": "Language / locale", "type": "string", "description": "ISO locale used for localized review dates and Airbnb auto-translations (e.g. 'en', 'es', 'fr', 'de'). Original review text is always returned in 'comments'; the translated text, when available, is returned in 'localizedReview'. Defaults to 'en'.", "default": "en" }, "includeHostResponse": { "title": "Include host responses", "type": "boolean", "description": "When enabled, includes the host's public reply to each review in the 'hostResponse' field (null when the host did not reply). Disable to keep output smaller and cheaper to process. Defaults to true.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings used to reach Airbnb. Defaults to Apify datacenter proxies in the US, which work reliably against Airbnb's public review API. If you have access to Residential proxies and hit rate limits on very large jobs, you can switch to them here.", "default": { "useApifyProxy": true, "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }