{ "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": "UBh4tGcNK4tqN4pgV" }, "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": { "mode": { "title": "Mode", "enum": [ "search-fast", "search-full", "urls" ], "type": "string", "description": "search-fast: cards only (fastest). search-full: cards + full listing details. urls: scrape direct listing URLs.", "default": "search-fast" }, "locationQueries": { "title": "Location queries", "type": "array", "description": "Free-text locations or Airbnb slugs. Each entry yields up to maxItemsPerQuery listings.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct Airbnb listing URLs (https://www.airbnb.com/rooms/). Used only in 'urls' mode.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD. Required to get prices in search results." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "YYYY-MM-DD." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests for price/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 }, "minPrice": { "title": "Min price per night", "minimum": 0, "type": "integer", "description": "In the chosen currency." }, "maxPrice": { "title": "Max price per night", "minimum": 0, "type": "integer", "description": "In the chosen currency." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Filter out listings with fewer bedrooms than this." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Filter out listings with fewer bathrooms than this." }, "minBeds": { "title": "Min beds", "minimum": 0, "maximum": 50, "type": "integer", "description": "Filter out listings with fewer beds than this." }, "roomType": { "title": "Room type", "enum": [ "", "Entire home/apt", "Private room", "Shared room", "Hotel room" ], "type": "string", "description": "Filter listings by room type. Leave empty for any.", "default": "" }, "maxItemsPerQuery": { "title": "Max items per query", "minimum": 1, "maximum": 270, "type": "integer", "description": "Cap on listings per locationQuery or per startUrl. Airbnb's natural ceiling is ~270 (15 pages x 18).", "default": 50 }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Fetch reviews via StaysPdpReviewsQuery. Only in search-full and urls modes.", "default": false }, "includeCalendar": { "title": "Include availability calendar", "type": "boolean", "description": "Fetch 12-month availability via PdpAvailabilityCalendar. Only in search-full and urls modes.", "default": false }, "currency": { "title": "Currency", "enum": [ "USD", "EUR" ], "type": "string", "description": "Only USD or EUR. RUB is intentionally not supported.", "default": "USD" }, "locale": { "title": "Locale", "enum": [ "en", "de", "fr", "es", "it", "pt", "nl", "pl", "ru" ], "type": "string", "description": "UI language for Airbnb responses (descriptions, host details, etc.).", "default": "en" }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy works out of the box. If your plan has DATACENTER access, set apifyProxyGroups=['DATACENTER'] for the cheapest path; otherwise leave groups empty (Apify picks an available group for you) or use RESIDENTIAL.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 50, "type": "integer", "description": "Global cap on parallel HTTP requests to Airbnb. This is the honest ceiling -- every Niobe call (search, details, calendar, reviews, BookIt) shares it. Pick by proxy type: residential 3-5, datacenter 10-20, no proxy 20-30. Higher than 30 yields no extra throughput because Airbnb's own latency dominates.", "default": 10 }, "maxRetries": { "title": "Max retries per item", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry transient errors (429, 5xx) per request before giving up.", "default": 5 }, "rawOutput": { "title": "Raw output", "type": "boolean", "description": "Include the full Niobe GraphQL response under _raw in each item.", "default": false }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Enable verbose DEBUG-level logging.", "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 } } } } } } } } } }