{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper", "description": "Scrape Airbnb listings via location search or direct URLs. Three modes: search-fast (cards only), search-full (full details), urls (specific listings). HTTP-only, no browsers.", "version": "0.1", "x-build-id": "M8ovAPktMDGivWJ7T" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/trakk~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-trakk-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/trakk~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-trakk-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/trakk~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-trakk-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(s)", "type": "array", "description": "Free-text locations or Airbnb slugs. Each location yields up to the selected number of listings.", "items": { "type": "string" }, "default": [] }, "checkIn": { "title": "📅 Check-in date", "type": "string", "description": "YYYY-MM-DD. Add dates when you need prices or availability." }, "checkOut": { "title": "📅 Check-out date", "type": "string", "description": "YYYY-MM-DD. Should be later than check-in." }, "maxItemsPerQuery": { "title": "💯 Listings per location or URL", "minimum": 1, "maximum": 270, "type": "integer", "description": "Cap on listings per location query or per start URL. Airbnb's natural search ceiling is about 270.", "default": 50 }, "mode": { "title": "🧭 Input type", "enum": [ "auto", "search-fast", "search-full", "urls" ], "type": "string", "description": "AUTO uses direct URLs when provided, otherwise runs a location search. Fast search returns cards; full search enriches each listing.", "default": "auto" }, "adults": { "title": "👤 Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests for price and availability.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "maximum": 10, "type": "integer", "description": "Number of children ages 2-12.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of infants under 2.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of pets traveling with you.", "default": 0 }, "startUrls": { "title": "🔗 Airbnb listing URL(s)", "type": "array", "description": "Direct Airbnb listing URLs in the format https://www.airbnb.com/rooms/.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeReviews": { "title": "⭐ Include reviews", "type": "boolean", "description": "Fetch listing reviews. Works in search-full and direct URL modes.", "default": false }, "includeCalendar": { "title": "📆 Include availability calendar", "type": "boolean", "description": "Fetch 12-month availability calendar. Works in search-full and direct URL modes.", "default": false }, "minPrice": { "title": "Minimum price per night", "minimum": 0, "type": "integer", "description": "Price filter in the selected currency." }, "maxPrice": { "title": "Maximum price per night", "minimum": 0, "type": "integer", "description": "Price filter in the selected currency." }, "roomType": { "title": "Room type", "enum": [ "", "Entire home/apt", "Private room", "Shared room", "Hotel room" ], "type": "string", "description": "Filter listings by room type. Leave Any for no room-type filter.", "default": "" }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Filter out listings with fewer bedrooms than this." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Filter out listings with fewer bathrooms than this." }, "minBeds": { "title": "Minimum beds", "minimum": 0, "maximum": 50, "type": "integer", "description": "Filter out listings with fewer beds than this." }, "currency": { "title": "💵 Currency", "enum": [ "USD", "EUR" ], "type": "string", "description": "Currency used for pricing fields.", "default": "USD" }, "locale": { "title": "Language / locale", "enum": [ "en", "de", "fr", "es", "it", "pt", "nl", "pl", "ru" ], "type": "string", "description": "UI language for Airbnb responses such as descriptions and host details.", "default": "en" }, "rawOutput": { "title": "Include raw Airbnb response", "type": "boolean", "description": "Include the full Niobe GraphQL response under _raw in each item. Usually only needed for debugging.", "default": false }, "maxConcurrency": { "title": "⚙️ Max concurrent requests", "minimum": 1, "maximum": 50, "type": "integer", "description": "Global cap on parallel HTTP requests to Airbnb. Residential proxy: 3-5; datacenter/no proxy can usually go higher.", "default": 10 }, "maxRetries": { "title": "Max retries per item", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry transient errors such as 429 and 5xx before giving up.", "default": 5 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy works out of the box. Use residential proxies for tougher locations or larger runs.", "default": { "useApifyProxy": true } }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Enable verbose DEBUG-level logging. Keep off for normal runs.", "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 } } }, "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 } } } } } } } } } }