{ "openapi": "3.0.1", "info": { "title": "Airbnb Reviews Scraper", "description": "Export public Airbnb guest reviews from listing URLs, with text, dates, reviewer details, available ratings, host replies, and listing context. Download CSV or JSON.", "version": "0.1", "x-build-id": "ZThB4Ew7Lmem1iEkJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~airbnb-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-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/fetch_cat~airbnb-reviews-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-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/fetch_cat~airbnb-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Airbnb listing URLs", "type": "array", "description": "Public Airbnb /rooms/ URLs, for example https://www.airbnb.com/rooms/20669368. Up to 100 unique listings are processed per run; additional URLs are not processed. Supported country-domain URLs are normalized to airbnb.com. For continuation-only input, supply an empty startUrls array and the resumeListingUrls from your checkpoint.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviewsPerListing": { "title": "Maximum reviews per listing", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum review batch to examine per listing, from 1 to 1000; default 25 (the form starts with 10). Date, rating and keyword filters apply after retrieval, so fewer matching reviews may be saved. The Actor does not continue searching until this many matches are saved.", "default": 25 }, "sort": { "title": "Review sort order", "enum": [ "default", "recent" ], "type": "string", "description": "Use Airbnb's default order or request recent reviews when available.", "default": "default" }, "dateFrom": { "title": "Only reviews on or after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional inclusive ISO date (YYYY-MM-DD). Useful for collecting new reviews in scheduled runs." }, "dateTo": { "title": "Only reviews on or before", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional inclusive ISO date (YYYY-MM-DD)." }, "keyword": { "title": "Review keyword", "maxLength": 200, "type": "string", "description": "Optional word or phrase that must appear in the review, its Airbnb translation, or the host response." }, "minRating": { "title": "Minimum review rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Optional minimum per-review star rating to save." }, "maxRating": { "title": "Maximum review rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Optional maximum per-review star rating to save." }, "resumeListingUrls": { "title": "Resume pending listing URLs", "type": "array", "description": "Continuation URLs from the PENDING_LISTINGS record, created only when the run stops early for its time limit. Supply startUrls: [] to resume only these listings. The current partly processed listing may be repeated; compare listingId and reviewId downstream to avoid double-counting across runs.", "items": { "type": "string" } }, "runSafetySeconds": { "title": "Run safety limit (seconds)", "minimum": 60, "maximum": 270, "type": "integer", "description": "Optional early-stop limit for larger batches. The Actor saves completed review rows and a PENDING_LISTINGS checkpoint before this limit, leaving time for clean shutdown.", "default": 270 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is enabled by default and is used from the first request, not only after a direct request fails. Keep the existing managed settings or supply your own proxy URLs. To request direct access, set useApifyProxy to false without proxyUrls. Explicit supplied settings are passed to Apify unchanged; omitted settings use the SDK's managed-proxy configuration. There is no automatic switch from direct access to paid proxies. Proxy availability and charges depend on your Apify account; no proxy type guarantees access.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }