{ "openapi": "3.0.1", "info": { "title": "Airbnb Reviews Scraper โ€” vacation rental review data", "description": "Scrape airbnb.com reviews for any listing URL or a whole city. Get flat rows covering guest feedback and ratings, reviewer context, listing links and host replies. Control review order and per-listing volume for downstream research and sentiment workflows.", "version": "0.1", "x-build-id": "FHbcmZbjrUIpjHXgK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~airbnb-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-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/blackfalcondata~airbnb-reviews-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-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/blackfalcondata~airbnb-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-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": { "startUrls": { "title": "๐Ÿ”— Listing URLs", "type": "array", "description": "Paste Airbnb room URLs (e.g. https://www.airbnb.com/rooms/992970965790772607). Reviews are scraped for each. Search-result URLs also work โ€” their location is read from the URL.", "items": { "type": "string" } }, "searchLocations": { "title": "๐Ÿ“ Locations", "type": "array", "description": "One or more places: a city, a neighborhood, or \"City, ST\" (e.g. \"New York, NY\"). Each is searched to discover listings, then reviews are scraped for each listing found. Leave empty if you only use Listing URLs.", "items": { "type": "string" } }, "reviewsMaxPerListing": { "title": "๐Ÿ”ข Reviews Per Listing", "minimum": 0, "type": "integer", "description": "Cap the number of reviews fetched per listing (0 = all available).", "default": 10 }, "reviewSort": { "title": "โ†•๏ธ Review Order", "enum": [ "best", "recent" ], "type": "string", "description": "How to order reviews.", "default": "best" }, "maxResults": { "title": "๐Ÿ’ฏ Max Results", "minimum": 0, "type": "integer", "description": "Maximum reviews to return (0 = no limit). When discovering by location, also bounds how many listings are scanned.", "default": 100 }, "maxQueries": { "title": "๐Ÿงฎ Max Queries (cost guard)", "minimum": 1, "type": "integer", "description": "Optional hard ceiling on how much work location discovery does. Leave empty for the default. Lower it to cap cost on very dense areas." }, "priceMin": { "title": "๐Ÿ’ฐ Min Price (USD / night)", "minimum": 0, "type": "integer", "description": "When discovering by location, only pull reviews for listings at or above this nightly price." }, "priceMax": { "title": "๐Ÿ’ฐ Max Price (USD / night)", "minimum": 0, "type": "integer", "description": "When discovering by location, only pull reviews for listings at or below this nightly price." }, "roomTypes": { "title": "๐Ÿ  Room Types", "type": "array", "description": "When discovering by location, restrict to one or more room types. Leave empty for all.", "items": { "type": "string", "enum": [ "Entire home/apt", "Private room", "Shared room", "Hotel room" ], "enumTitles": [ "Entire home/apt", "Private room", "Shared room", "Hotel room" ] }, "default": [] }, "minBedrooms": { "title": "๐Ÿ›๏ธ Min Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "adults": { "title": "๐Ÿ‘ฅ Guests", "minimum": 1, "type": "integer", "description": "Number of guests (adults) to price for." }, "checkin": { "title": "๐Ÿ“… Check-in", "type": "string", "description": "Optional stay start date (YYYY-MM-DD). Use with Check-out to price a specific stay and, with detail enrichment, to get the cancellation policy for it." }, "checkout": { "title": "๐Ÿ“… Check-out", "type": "string", "description": "Optional stay end date (YYYY-MM-DD)." }, "children": { "title": "๐Ÿง’ Children", "minimum": 0, "type": "integer", "description": "Children (ages 2โ€“12) travelling. They count toward the number of guests a place must sleep." }, "infants": { "title": "๐Ÿ‘ถ Infants", "minimum": 0, "type": "integer", "description": "Infants (under 2) travelling." }, "pets": { "title": "๐Ÿพ Pets", "minimum": 0, "type": "integer", "description": "Pets travelling. Only places that allow pets are returned." }, "minBeds": { "title": "๐Ÿ›๏ธ Min Beds", "minimum": 0, "type": "integer", "description": "Minimum number of beds." }, "minBathrooms": { "title": "๐Ÿ› Min Bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms." }, "propertyTypes": { "title": "๐Ÿ˜๏ธ Property Types", "type": "array", "description": "Restrict to one or more property types. Leave empty for all.", "items": { "type": "string", "enum": [ "House", "Apartment", "Guesthouse", "Hotel" ], "enumTitles": [ "House", "Apartment", "Guesthouse", "Hotel" ] } }, "amenities": { "title": "๐Ÿงบ Amenities", "type": "array", "description": "Only places that have every amenity listed, including accessibility features (step-free access, grab bars, wide entrances) and Waterfront. Leave empty for any.", "items": { "type": "string", "enum": [ "Wifi", "Kitchen", "Washer", "Dryer", "Air conditioning", "Heating", "Dedicated workspace", "TV", "Hair dryer", "Iron", "Pool", "Hot tub", "Free parking", "EV charger", "Crib", "King bed", "Gym", "BBQ grill", "Breakfast", "Indoor fireplace", "Smoking allowed", "Self check-in", "Smoke alarm", "Carbon monoxide alarm", "Step-free access", "Disabled parking spot", "Guest entrance wider than 32 inches", "Step-free bedroom access", "Bedroom entrance wider than 32 inches", "Step-free bathroom access", "Bathroom entrance wider than 32 inches", "Toilet grab bar", "Shower grab bar", "Step-free shower", "Shower or bath chair", "Ceiling or mobile hoist", "Waterfront" ], "enumTitles": [ "Wifi", "Kitchen", "Washer", "Dryer", "Air conditioning", "Heating", "Dedicated workspace", "TV", "Hair dryer", "Iron", "Pool", "Hot tub", "Free parking", "EV charger", "Crib", "King bed", "Gym", "BBQ grill", "Breakfast", "Indoor fireplace", "Smoking allowed", "Self check-in", "Smoke alarm", "Carbon monoxide alarm", "Step-free access", "Disabled parking spot", "Guest entrance wider than 32 inches", "Step-free bedroom access", "Bedroom entrance wider than 32 inches", "Step-free bathroom access", "Bathroom entrance wider than 32 inches", "Toilet grab bar", "Shower grab bar", "Step-free shower", "Shower or bath chair", "Ceiling or mobile hoist", "Waterfront" ] } }, "instantBook": { "title": "โšก Instant Book only", "type": "boolean", "description": "Only places you can book without waiting for host approval." }, "guestFavorite": { "title": "๐Ÿ… Guest favorites only", "type": "boolean", "description": "Only places Airbnb marks as a guest favorite." }, "superhost": { "title": "โญ Superhosts only", "type": "boolean", "description": "Only places hosted by a Superhost." }, "luxe": { "title": "๐Ÿ’Ž Airbnb Luxe only", "type": "boolean", "description": "Only Airbnb Luxe places." }, "hostLanguages": { "title": "๐Ÿ—ฃ๏ธ Host Languages", "type": "array", "description": "Only hosts who speak one of these languages. Two-letter codes (e.g. \"en\", \"fr\", \"es\") or language names.", "items": { "type": "string" } }, "privateBathroom": { "title": "๐Ÿšฟ Private attached bathroom only", "type": "boolean", "description": "Only places where your bathroom is private and attached to your room (en-suite)." }, "neighborhoods": { "title": "๐Ÿ˜๏ธ Neighbourhoods", "type": "array", "description": "Only places in these neighbourhoods of the searched location, as Airbnb names them in its own filter (e.g. \"Zilker\", \"East Austin\"). An Airbnb neighbourhood id from a search URL works too. If a name is not offered for your location, the run stops and lists the names that are.", "items": { "type": "string" } }, "currency": { "title": "๐Ÿ’ฑ Currency", "pattern": "^([A-Za-z]{3})?$", "type": "string", "description": "Three-letter currency code prices are quoted in, such as EUR, GBP or JPY. Price filters use the same currency. Leave empty to use the currency a pasted Airbnb URL names (?currency=EUR), otherwise USD." }, "locale": { "title": "๐ŸŒ Language", "pattern": "^([A-Za-z]{2}([-_][A-Za-z]{2,4})?)?$", "type": "string", "description": "Language for titles, labels and text, as an Airbnb language code such as de, fr, es or pt-BR. Leave empty to use the language a pasted Airbnb URL names (?locale=de), otherwise English." }, "centerLat": { "title": "๐Ÿงญ Center Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Optional radius search โ€” center latitude (decimal, e.g. 40.7128). With Center Longitude + Radius, searches that area on the map and keeps only listings within the radius. Works with or without a location." }, "centerLng": { "title": "๐Ÿงญ Center Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Radius filter โ€” center longitude (decimal, e.g. -74.0060)." }, "radiusKm": { "title": "๐Ÿ“ Radius (km)", "minimum": 0, "type": "integer", "description": "Keep only listings within this many kilometres of the center point." }, "excludeEmptyFields": { "title": "๐Ÿงน Exclude Empty Fields", "type": "boolean", "description": "Drop null / empty-string fields from each review record.", "default": false }, "telegramToken": { "title": "๐Ÿ”‘ Telegram Bot Token", "type": "string", "description": "Telegram bot token (from @BotFather). Required for Telegram notifications." }, "telegramChatId": { "title": "๐Ÿ’ฌ Telegram Chat ID", "type": "string", "description": "Telegram chat or channel ID where alerts are sent." }, "discordWebhookUrl": { "title": "๐ŸŽฎ Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL." }, "slackWebhookUrl": { "title": "๐Ÿ’ผ Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL." }, "whatsappPhoneNumberId": { "title": "๐Ÿ“ฑ WhatsApp Phone Number ID", "type": "string", "description": "WhatsApp Business phone number ID from Meta Business Manager." }, "whatsappAccessToken": { "title": "๐Ÿ” WhatsApp Access Token", "type": "string", "description": "Meta Cloud API access token with whatsapp_business_messaging scope." }, "whatsappTo": { "title": "๐Ÿ“จ WhatsApp Recipient", "type": "string", "description": "Recipient phone number in E.164 format (e.g. +14155551234)." }, "webhookUrl": { "title": "๐Ÿช Generic Webhook URL", "type": "string", "description": "Universal escape hatch for n8n / Make / Zapier / custom HTTP backends. Receives a JSON POST per run." }, "webhookHeaders": { "title": "๐Ÿช Webhook Headers (optional)", "type": "object", "description": "Additional HTTP headers sent with the generic webhook POST." }, "notificationLimit": { "title": "๐Ÿ“Š Max Records Per Notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of records included in each notification message (1โ€“20).", "default": 5 }, "notifyOnlyChanges": { "title": "๐Ÿ”„ Notify Only New/Updated", "type": "boolean", "description": "When change tracking applies, only send notifications for new or updated records.", "default": false }, "appConnector": { "title": "๐Ÿ“ค Send results to a connected app", "type": "string", "description": "Optional. Pick a connected app under Settings โ†’ API & Integrations to receive your results. A run-summary is written to the connected app; support is best-effort as Apify expands its connector catalog." }, "mcpIssueTeam": { "title": "๐Ÿท๏ธ Issue tracker team", "type": "string", "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one." }, "compact": { "title": "๐Ÿ“ฆ Compact Output (for AI / MCP)", "type": "boolean", "description": "Return only core fields. Reduces payload size for LLM pipelines and agent tools.", "default": 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 } } } } } } } } } }