{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper", "description": "This actor extracts Airbnb property data to help real estate investors and analysts evaluate short-term rental markets. Get details on nightly rates, occupancy signals, and listing density fast.", "version": "0.1", "x-build-id": "SOqHyrcTDTwSIeVW2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapio~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapio-airbnb-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/scrapio~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-scrapio-airbnb-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/scrapio~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-scrapio-airbnb-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": { "locationQueries": { "title": "📍 Location keywords", "type": "array", "description": "Cities/neighborhoods to search. For US cities add the state like `Austin--TX` so the right area is matched. Example: `[\"paris\", \"Austin--TX\"]`.", "items": { "type": "string" } }, "startUrls": { "title": "🔗 Airbnb URLs or room IDs", "type": "array", "description": "Direct room URLs (`https://www.airbnb.com/rooms/12345`), numeric room IDs (`12345`), or full search URLs. Room URLs/IDs are scraped directly (no search). Example: `[\"29774978\", \"https://www.airbnb.com/rooms/12345\"]`.", "items": { "type": "string" } }, "checkin": { "title": "🛎️ Check-in", "type": "string", "description": "When the stay starts — calendar date `YYYY-MM-DD` or relative (e.g. `14 days`, `2 weeks`). Future dates give live prices. Default: `30 days` from today.", "default": "30 days" }, "checkout": { "title": "🚪 Check-out", "type": "string", "description": "When the stay ends — must be after check-in. Same calendar/relative format. Default: `34 days` from today (a 4-night stay).", "default": "34 days" }, "adults": { "title": "🧑 Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests. Example: `2`.", "default": 2 }, "children": { "title": "🧒 Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Number of children (ages 2–12). Example: `0`.", "default": 0 }, "infants": { "title": "👶 Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of infants (under 2). Example: `0`.", "default": 0 }, "pets": { "title": "🐾 Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of pets. Example: `0`.", "default": 0 }, "maxItems": { "title": "🔢 Max listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many listings that match your search and area. Reviews do NOT count toward this. Example: `10`.", "default": 10 }, "maxPages": { "title": "📄 Max search pages (optional)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Advanced: cap how many search result pages to walk. Leave empty for an automatic sensible cap." }, "strictGeo": { "title": "📌 Strictly stay in my search area", "type": "boolean", "description": "When ON, only keep listings whose coordinates fall in the resolved area (great when a city name exists in several countries). When OFF, more nearby/similar-name results may appear.", "default": true }, "includeDetails": { "title": "🧩 Fetch full listing details", "type": "boolean", "description": "When ON (recommended) each listing gets host profile, amenities, full photo gallery, sleeping arrangements, description and itemized fees. When OFF, only search-page fields are emitted (faster, fewer fields). Direct room URLs/IDs always fetch details.", "default": true }, "includeReviews": { "title": "💬 Include individual reviews", "type": "boolean", "description": "When ON, fetch individual guest reviews for each listing and emit them as separate child rows (type=review, isChild=true), linked to the listing via parentId. Reviews are also mirrored to a per-run `reviews-` dataset.", "default": false }, "maxReviewsPerListing": { "title": "💬 Max reviews per listing", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Cap reviews fetched per listing (0 = unlimited). Only applies when reviews are enabled. Example: `20`.", "default": 20 }, "minPrice": { "title": "💲 Min nightly price", "minimum": 0, "type": "integer", "description": "Only keep listings whose per-night price is at least this (in the chosen currency). 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "💲 Max nightly price", "minimum": 0, "type": "integer", "description": "Only keep listings whose per-night price is at most this. 0 = no maximum.", "default": 0 }, "roomType": { "title": "🏘️ Room type", "enum": [ "any", "entire_home", "private_room", "shared_room", "hotel_room" ], "type": "string", "description": "Keep only this room type. `Any` = no filter.", "default": "any" }, "superhostOnly": { "title": "⭐ Superhost only", "type": "boolean", "description": "Keep only listings whose host is a Superhost.", "default": false }, "guestFavoriteOnly": { "title": "💛 Guest Favorite only", "type": "boolean", "description": "Keep only listings badged as a Guest Favorite.", "default": false }, "minRating": { "title": "🌟 Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep only listings with an overall rating at least this value (0–5). 0 = no minimum.", "default": 0 }, "minReviews": { "title": "🗳️ Minimum reviews count", "minimum": 0, "type": "integer", "description": "Keep only listings with at least this many reviews. 0 = no minimum.", "default": 0 }, "keywords": { "title": "🔤 Must contain keywords", "type": "array", "description": "Keep only listings whose title/description contains at least one of these (case-insensitive). Example: `[\"pool\", \"downtown\"]`.", "items": { "type": "string" } }, "excludeKeywords": { "title": "🚫 Exclude keywords", "type": "array", "description": "Drop listings whose title/description contains any of these. Example: `[\"shared\", \"hostel\"]`.", "items": { "type": "string" } }, "currency": { "title": "💵 Currency", "enum": [ "USD", "EUR", "GBP", "JPY", "AUD", "CAD", "CHF", "CNY", "INR", "BRL", "MXN", "SEK", "NOK", "DKK", "PLN", "NZD", "SGD", "HKD", "KRW", "TRY", "ZAR", "AED", "THB", "MYR", "PHP", "IDR", "CZK", "HUF", "ILS", "SAR", "CLP", "ARS", "COP", "PEN", "RON", "BGN", "HRK", "ISK", "TWD", "VND" ], "type": "string", "description": "Currency for all prices.", "default": "USD" }, "locale": { "title": "🌐 Language & region (locale)", "enum": [ "en-US", "en-GB", "en-AU", "en-CA", "en-IN", "en-IE", "fr-FR", "fr-CA", "de-DE", "es-ES", "es-MX", "es-AR", "it-IT", "pt-BR", "pt-PT", "ja-JP", "ko-KR", "zh-CN", "zh-TW", "nl-NL", "nl-BE", "sv-SE", "da-DK", "nb-NO", "fi-FI", "pl-PL", "ru-RU", "tr-TR", "el-GR", "cs-CZ", "hu-HU", "ro-RO", "uk-UA", "id-ID", "th-TH", "vi-VN", "ms-MY", "hi-IN", "he-IL", "ar-SA", "ca-ES", "hr-HR", "sk-SK", "sl-SI", "bg-BG", "lt-LT", "lv-LV", "et-EE" ], "type": "string", "description": "Language/region Airbnb uses for labels and text.", "default": "en-US" }, "state": { "title": "📍 Region / state / province", "type": "string", "description": "Optional region name to disambiguate (e.g. `Texas`). Leave empty if your search is already specific.", "default": "" }, "country": { "title": "🌎 Country", "type": "string", "description": "Optional country to disambiguate (e.g. `United States`). Leave empty if you are sure.", "default": "" }, "aiEnhancement": { "title": "🤖 Enable AI review analysis", "type": "boolean", "description": "When ON, each fetched review gets aiSentiment, aiTopics and aiLanguage. Requires reviews enabled and an API key below.", "default": false }, "aiModel": { "title": "🤖 AI Model / Provider", "enum": [ "claude-haiku-4-5", "claude-sonnet-5", "claude-opus-4-8", "gpt-4o-mini", "gpt-4o", "gpt-4.1-mini", "o3-mini", "gemini-2.0-flash-lite", "gemini-2.0-flash", "gemini-2.5-flash", "grok-3-mini", "deepseek-chat", "sonar", "mistral-small-latest" ], "type": "string", "description": "Provider auto-detected from the name: claude-*=Anthropic, gpt-*/o1/o3=OpenAI, gemini-*=Google, grok-*=xAI, deepseek-*=DeepSeek, sonar*=Perplexity, mistral-*=Mistral. Cheaper mini/flash/haiku models are recommended for classification.", "default": "claude-haiku-4-5" }, "aiApiKey": { "title": "🔑 AI API key", "type": "string", "description": "API key for the selected provider. Falls back to the provider env var (ANTHROPIC_API_KEY / OPENAI_API_KEY / GEMINI_API_KEY / XAI_API_KEY / DEEPSEEK_API_KEY / PERPLEXITY_API_KEY / MISTRAL_API_KEY) if left empty." }, "proxyConfiguration": { "title": "🔌 Proxy", "type": "object", "description": "Configure Apify Proxy if needed; otherwise connect directly." } } }, "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 } } } } } } } } } }