{ "openapi": "3.0.1", "info": { "title": "Airbnb Occupancy Scraper with Booking Rate Percentage", "description": "Scrape Airbnb occupancy data for any listing or region. Get availability, booked dates, calendar insights, and pricing trends to support market research, revenue planning, and competitive analysis. Outputs clean, structured data.", "version": "0.1", "x-build-id": "6r4FX2YkJCMBOfdXZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~airbnb-occupancy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-airbnb-occupancy-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/scraper-engine~airbnb-occupancy-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-airbnb-occupancy-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/scraper-engine~airbnb-occupancy-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-airbnb-occupancy-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", "required": [ "stayListings" ], "properties": { "stayListings": { "title": "🔑 Airbnb Listings (IDs or URLs)", "type": "array", "description": "Airbnb room IDs or full room URLs to scan for open dates. Example: 35329051 or https://www.airbnb.com/rooms/35329051. Accepts the legacy 'roomIds' key too.", "items": { "type": "string" } }, "searchFromMonth": { "title": "🗓️ Scan From Month", "minimum": 1, "maximum": 12, "type": "integer", "description": "First month (1-12) of the availability window to scan for open dates. Example: 12 = start scanning in December. Default is 12. (Legacy key 'month' is accepted.)" }, "searchFromYear": { "title": "🗓️ Scan From Year", "type": "integer", "description": "Year of the first month in the scan window. Example: 2026. Default is 2026. (Legacy key 'year' is accepted.)" }, "monthsToScan": { "title": "📆 Months To Scan", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many consecutive months to scan forward from the start month (1-12). Example: monthsToScan=3 scans a ~90-day open-date window. Default is 12.", "default": 12 }, "minGapNights": { "title": "🎯 Minimum Open-Gap Nights", "minimum": 1, "type": "integer", "description": "Only return open date ranges (gaps) with at least this many consecutive open nights. Example: minGapNights=3 hides 1- and 2-night openings and returns only gaps of 3+ open nights. Default is 1 (return every open range).", "default": 1 }, "includeGapRanges": { "title": "📂 Emit One Row Per Open Gap", "type": "boolean", "description": "When on, emit a detail row for every open date range (startDate, endDate, lengthNights) in addition to the per-listing summary row. Turn off for a summary-only run (one row per listing). Default is true.", "default": true }, "proxyConfiguration": { "title": "🌐 Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxies are strongly recommended for Airbnb; the actor auto-falls back to residential on blocks." } } }, "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 } } } } } } } } } }