{ "openapi": "3.0.1", "info": { "title": "Airbnb Reviews Scraper", "description": "Collect public Airbnb guest reviews with ratings, complete text, listing details and optional host responses. Available fields and review coverage depend on the public website.", "version": "1.1", "x-build-id": "KMbVCZVKSza6MRwU3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codingfrontend~airbnb-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codingfrontend-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/codingfrontend~airbnb-reviews-scraper/runs": { "post": { "operationId": "runs-sync-codingfrontend-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/codingfrontend~airbnb-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-codingfrontend-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", "required": [ "productUrls" ], "properties": { "productUrls": { "title": "Listing URLs", "minItems": 1, "maxItems": 20, "type": "array", "description": "Required Airbnb listing links. Use HTTPS and the exact /rooms/ path. Regional Airbnb domains, harmless tracking parameters, and page fragments are accepted; listing IDs are deduplicated.", "items": { "type": "string", "pattern": "^https://(?:www\\.)?airbnb\\.(?:com|[a-z]{2}|(?:co|com)\\.[a-z]{2})/rooms/[0-9]+(?:\\?[^#\\s]*)?(?:#[^\\s]*)?$" } }, "maxReviewsPerListing": { "title": "Max Reviews Per Listing", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum review rows to save from each listing. Set to 0 for all available reviews.", "default": 0 }, "maxTotalReviews": { "title": "Max Total Reviews", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Overall review-row limit across all listing URLs. Set to 0 for no run-wide cap.", "default": 0 }, "includeHostResponses": { "title": "Include Host Responses", "type": "boolean", "description": "Include available host response text and response author details.", "default": true }, "includeListingMetadata": { "title": "Include Listing Metadata", "type": "boolean", "description": "Include public listing ratings, capacity, host details, description, amenities, photos, sleeping arrangements, location notes, house rules, and safety information.", "default": true }, "includeReviewerDetails": { "title": "Include Reviewer Details", "type": "boolean", "description": "Include public reviewer profile, location, tenure, and avatar details shown with reviews.", "default": true }, "reviewSearch": { "title": "Review Search", "maxLength": 200, "type": "string", "description": "Optional phrase to search in Airbnb's review panel. A listing with no matches produces no review rows.", "default": "" }, "reviewSort": { "title": "Review Sort", "enum": [ "BEST_QUALITY", "MOST_RECENT", "HIGHEST_RATED", "LOWEST_RATED" ], "type": "string", "description": "Sort order available in Airbnb's review panel.", "default": "BEST_QUALITY" }, "maxConcurrency": { "title": "Max Browser Concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum number of listing pages processed at the same time. Lower values reduce concurrent requests.", "default": 1 }, "maxRequestRetries": { "title": "Max Request Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Maximum retries for transient listing navigation or source request failures. Access-denied pages are not retried.", "default": 1 }, "requestDelayMs": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Additional wait before each listing navigation, in milliseconds.", "default": 1000 }, "requestTimeoutSecs": { "title": "Request Timeout (seconds)", "minimum": 15, "maximum": 180, "type": "integer", "description": "Navigation timeout for each listing and its review page.", "default": 60 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Default: Apify Residential proxies. Apify proxy groups/country and custom proxy URLs are separate routes. Custom proxy URLs may include authentication credentials; do not paste credentials into public examples or logs.", "properties": { "useApifyProxy": { "title": "Use Apify Proxy", "description": "Use Apify-managed proxies when true; set false for custom proxy URLs or no proxy.", "type": "boolean" }, "apifyProxyGroups": { "title": "Apify Proxy Groups", "description": "Optional Apify proxy groups. An empty array selects groups automatically.", "type": "array", "items": { "type": "string" } }, "apifyProxyCountry": { "title": "Apify Proxy Country", "description": "Optional two-letter country code for Apify Proxy.", "type": "string", "maxLength": 2, "pattern": "^[A-Za-z]{2}$" }, "proxyUrls": { "title": "Custom Proxy URLs", "description": "Custom HTTP(S) proxy URLs, used only when Apify Proxy is disabled.", "type": "array", "items": { "type": "string" } } }, "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] }, "additionalProperties": 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 } } } } } } } } } }