{ "openapi": "3.0.1", "info": { "title": "Airbnb Reviews Scraper", "description": "Export flat, deduplicated Airbnb reviews with ratings, public reviewer fields, host responses, practical filters, per-listing coverage, and optional repeat-run change tracking.", "version": "0.10", "x-build-id": "b4lTdiPgGLkN2ezuQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luminar~airbnb-reviews-scraper-private-v1/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luminar-airbnb-reviews-scraper-private-v1", "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/luminar~airbnb-reviews-scraper-private-v1/runs": { "post": { "operationId": "runs-sync-luminar-airbnb-reviews-scraper-private-v1", "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/luminar~airbnb-reviews-scraper-private-v1/run-sync": { "post": { "operationId": "run-sync-luminar-airbnb-reviews-scraper-private-v1", "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": [ "listingUrls" ], "properties": { "listingUrls": { "title": "🔗 Airbnb listing URLs", "maxItems": 100, "type": "array", "description": "Paste one or more public Airbnb /rooms/{id} URLs. Duplicate listing IDs are processed once. Start with one URL and the prefilled 25-review limit; large batches remain bounded by the safety ceilings below.", "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": 5000, "type": "integer", "description": "Maximum review rows considered for each listing. Higher values can require more pages and runtime. Reaching this cap is reported as partial or bounded coverage, never source-complete.", "default": 25 }, "scrapeMode": { "title": "Coverage mode", "enum": [ "fast_recent", "full_pagination" ], "type": "string", "description": "Fast recent reviews makes the minimum requests for the requested newest window. Full pagination continues until the review cap, a safety ceiling or positive source exhaustion.", "default": "fast_recent" }, "sortBy": { "title": "Source sort", "enum": [ "MOST_RECENT", "BEST_QUALITY", "RATING_DESC", "RATING_ASC" ], "type": "string", "description": "Choose the source review order. Most recent is recommended for monitoring and is the only order that can stop early after crossing the lower date boundary.", "default": "MOST_RECENT" }, "sinceDate": { "title": "Published on or after", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Deterministic post-filter. With MOST_RECENT, older source pages can be skipped after the boundary is crossed." }, "untilDate": { "title": "Published on or before", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Deterministic post-filter applied to the source-returned review timestamp." }, "reviewLanguages": { "title": "Original review languages", "type": "array", "description": "Optional source-backed language-code allowlist, for example en, de or fr. Empty keeps every language.", "items": { "type": "string" } }, "minRating": { "title": "Minimum review rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Deterministic post-filter on the source review rating." }, "maxRating": { "title": "Maximum review rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Deterministic post-filter on the source review rating." }, "locale": { "title": "Source locale", "type": "string", "description": "Controls localized source labels and dates. The review text remains in its original source language.", "default": "en-US" }, "includeReviewerPublicFields": { "title": "Include public reviewer fields", "type": "boolean", "description": "Keeps only reviewer fields publicly exposed in the review response. Disable for a smaller data footprint.", "default": true }, "includeHostResponses": { "title": "Include host responses", "type": "boolean", "description": "Keeps host response text/date when exposed. This does not trigger a separate request in V1.", "default": true }, "incrementalMode": { "title": "Repeat-run state", "enum": [ "raw", "compare" ], "type": "string", "description": "Raw mode always emits CURRENT. A first changes-only Compare run creates a free review-row baseline; compatible repeats classify and emit NEW or UPDATED rows. Compare with unchanged output enabled still returns the full observed window.", "default": "raw" }, "includeUnchanged": { "title": "Write unchanged reviews to the dataset", "type": "boolean", "description": "In Track changes mode, turn this off to write only NEW and UPDATED rows. The first actor-scoped V2 baseline writes no review_result rows, preventing an upgrade from rebilling historical reviews. Compatible repeats emit changed rows; each verified non-failed target uses one monitor_target event.", "default": true }, "stateNamespace": { "title": "State namespace", "pattern": "^[A-Za-z0-9._-]{1,64}$", "type": "string", "description": "Use a short stable label to keep independent monitoring workflows separate. Reuse the same namespace and extraction settings for compatible comparisons.", "default": "default" }, "pageSize": { "title": "Reviews per source page", "minimum": 10, "maximum": 50, "type": "integer", "description": "Reviews requested per source page. Keep 50 for normal runs; smaller values usually increase request count and are intended for troubleshooting only.", "default": 50 }, "concurrency": { "title": "Listing concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Listings run concurrently; pagination within each listing stays ordered and bounded.", "default": 3 }, "maxRequests": { "title": "Maximum live source requests", "minimum": 2, "maximum": 500, "type": "integer", "description": "Hard total across all public-source work. The run stops before the next request would exceed this value.", "default": 60 }, "maxRuntimeSecs": { "title": "Maximum runtime (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Hard wall-clock ceiling checked before each live request.", "default": 240 }, "maxCostUsd": { "title": "Run safety cost ceiling", "minimum": 0.01, "maximum": 5, "type": "number", "description": "Stops new source work when the conservative run-cost estimate reaches this amount. This safeguard is separate from the Actor price.", "default": 0.25 }, "requestTimeoutSecs": { "title": "Per-request timeout (seconds)", "minimum": 10, "maximum": 60, "type": "integer", "description": "Maximum wait for one source request before the target is marked partial or failed.", "default": 45 } } }, "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 } } } } } } } } } }