{ "openapi": "3.0.1", "info": { "title": "Airbnb Market Reviews Scraper", "description": "Paste one Airbnb search URL and get every review from every listing in that market. Discovers listings, then downloads all review pages in parallel — thousands of reviews per minute.", "version": "0.1", "x-build-id": "q0xqsQnglTlFQQZMp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~airbnb-market-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-airbnb-market-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/cirkit~airbnb-market-reviews-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-airbnb-market-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/cirkit~airbnb-market-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-airbnb-market-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": { "startUrls": { "title": "Airbnb search URLs", "type": "array", "description": "Paste Airbnb search URLs, e.g. https://www.airbnb.com/s/Asheville--North-Carolina--United-States/homes. Any filters already in the URL (dates, price, bedrooms, amenities) are respected. Single-listing /rooms/ URLs are NOT accepted here — use the Airbnb Reviews Scraper for those.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locationQueries": { "title": "Or just destination names", "type": "array", "description": "Simpler alternative to URLs — list destinations like \"Austin, Texas\" or \"Lisbon, Portugal\". Each becomes its own market search, combined with the filters below.", "default": [], "items": { "type": "string" } }, "maxReviews": { "title": "Max reviews (total)", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Hard cap on reviews across the whole run — your main cost control. A mid-size market holds 20,000–40,000 reviews, so raise this deliberately.", "default": 1000 }, "maxListings": { "title": "Max listings to cover", "minimum": 1, "maximum": 270, "type": "integer", "description": "How many listings from the search to pull reviews from. Airbnb pages through at most ~270 listings per search; to cover a bigger market, split it by price band, dates, or property type across several search URLs.", "default": 100 }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 1, "type": "integer", "description": "Optional per-listing cap. Leave empty for every review. Useful for an even sample across a market instead of a few heavily-reviewed listings dominating." }, "reviewsSort": { "title": "Sort reviews by", "enum": [ "MOST_RECENT", "BEST_QUALITY", "RATING_DESC", "RATING_ASC" ], "type": "string", "description": "Order Airbnb returns reviews in. Keep Most recent when using the date filter.", "default": "MOST_RECENT" }, "dateFrom": { "title": "Reviews from", "type": "string", "description": "Only keep reviews on or after this date (YYYY-MM-DD). Note: filtering makes the run slower and less predictable, because pages are walked in waves instead of downloaded all at once." }, "dateTo": { "title": "Reviews until", "type": "string", "description": "Only keep reviews on or before this date (YYYY-MM-DD)." }, "checkIn": { "title": "Check-in", "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "YYYY-MM-DD, today or later. Narrows the market to listings available for these dates. Past or contradictory date pairs are ignored and the search runs dateless." }, "checkOut": { "title": "Check-out", "pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "YYYY-MM-DD, after check-in." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Guest count the listings must accommodate." }, "children": { "title": "Children", "minimum": 0, "maximum": 16, "type": "integer", "description": "Children (ages 2-12)." }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Infants (under 2)." }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Pets travelling along." }, "priceMin": { "title": "Min nightly price", "minimum": 0, "type": "integer", "description": "Lower bound in the selected currency. Handy for splitting a market that exceeds Airbnb's ~270-listing paging cap." }, "priceMax": { "title": "Max nightly price", "minimum": 0, "type": "integer", "description": "Upper bound in the selected currency." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bedrooms." }, "minBeds": { "title": "Min beds", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many beds." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bathrooms." }, "locale": { "title": "Locale", "enum": [ "en-US", "en-GB", "en-CA", "en-AU", "es-ES", "es-MX", "fr-FR", "de-DE", "it-IT", "pt-BR", "ja-JP", "zh-CN", "ko-KR" ], "type": "string", "description": "Language Airbnb localizes review dates and translations into.", "default": "en-US" }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "JPY", "CHF", "MXN", "BRL", "INR" ], "type": "string", "description": "ISO 4217 code used for the market search filters.", "default": "USD" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 100, "type": "integer", "description": "Parallel requests. This is the speed dial: every review page of every listing is queued at once, so higher means faster. Airbnb rate-limits per IP, so lower it (or switch to residential proxies) if you see repeated retries.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is enabled by default and is enough for most markets. For very large runs (50k+ reviews), switch to residential for a wider IP pool.", "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 } } }, "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 } } } } } } } } } }