{ "openapi": "3.0.1", "info": { "title": "Airbnb Occupancy Rate Scraper — Calendar Availability & ADR", "description": "Airbnb occupancy rate per listing and month from the public availability calendar, with a sampled nightly rate (ADR proxy) for each month. Search a place or give listing ids; get days available, days blocked or booked, occupancy % and the rate. Short term rental data at a fraction of a cent per row.", "version": "1.0", "x-build-id": "gMMOyo0o6jTgu3uL5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kestrel~airbnb-occupancy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kestrel-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/kestrel~airbnb-occupancy-scraper/runs": { "post": { "operationId": "runs-sync-kestrel-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/kestrel~airbnb-occupancy-scraper/run-sync": { "post": { "operationId": "run-sync-kestrel-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", "properties": { "locationQueries": { "title": "Places", "uniqueItems": true, "type": "array", "description": "Places to search exactly as you would type them on Airbnb: \"Lisbon, Portugal\", \"Algarve\", \"Brooklyn, NY\". Every listing found gets an occupancy row per month. An unrecognised place produces a status row (unknown_area) and costs nothing.", "items": { "type": "string" } }, "startUrls": { "title": "Airbnb URLs", "uniqueItems": true, "type": "array", "description": "Airbnb search URLs (their filters are honoured: room type, price band, bedrooms, map bounds) or listing URLs (https://www.airbnb.com/rooms/12345678).", "default": [], "items": { "type": "string" } }, "listingIds": { "title": "Listing ids", "uniqueItems": true, "type": "array", "description": "Numeric Airbnb listing ids — your own portfolio or a competitive set. No search needed; one occupancy row per id and month.", "default": [], "items": { "type": "string" } }, "maxListingsPerQuery": { "title": "Max listings per place", "minimum": 1, "maximum": 280, "type": "integer", "description": "Distinct listings to take per place or search URL (Airbnb returns at most about 280 for one search; split big areas into neighbourhoods for more). The main cost control for a market run.", "default": 40 }, "months": { "title": "Months", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many calendar months to read per listing, starting with the current month (1–12). One occupancy row per listing and month.", "default": 3 }, "includeRates": { "title": "Sample a nightly rate per month", "type": "boolean", "description": "Price the first bookable stay of each month (check-in on the first available day, the listing's minimum nights) and put its nightly rate on the occupancy row — an ADR proxy. One extra request per listing and month; turn off for a cheaper, availability-only run.", "default": true }, "adults": { "title": "Adults (for the rate sample)", "minimum": 1, "maximum": 16, "type": "integer", "description": "Guests the sampled stay is priced for; Airbnb prices depend on guest count.", "default": 2 }, "minOccupancyPct": { "title": "Min occupancy % (filter)", "minimum": 0, "maximum": 100, "type": "number", "description": "0 = deliver every month. N = deliver only months whose occupancy is at or above N %. Months under the line are dropped BEFORE billing, so a run looking for busy listings pays only for the busy months.", "default": 0 }, "includeListingRow": { "title": "Listing rows", "type": "boolean", "description": "Also emit one free listing row per listing (name, type, location, rating, reviews) — handy when you export the dataset to a sheet.", "default": false }, "currency": { "title": "Currency", "pattern": "^[A-Z]{3}$", "minLength": 3, "maxLength": 3, "type": "string", "description": "Currency for the sampled rates (USD, EUR, GBP, …). Echoed on every occupancy row.", "default": "USD" }, "locale": { "title": "Language", "type": "string", "description": "Airbnb locale for listing names (en, fr, de, es, pt, it, ja, …).", "default": "en" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Airbnb accepts Apify datacenter proxies for these calls; keep the default.", "default": { "useApifyProxy": true } }, "sessions": { "title": "Parallel proxy sessions", "minimum": 1, "maximum": 16, "type": "integer", "description": "Concurrent egress IPs; each paced at perIp requests per second.", "default": 4 }, "perIp": { "title": "Requests per second per IP", "minimum": 0.1, "maximum": 3, "type": "number", "description": "Pace per session. Airbnb tolerated 1 request/second and short bursts in tests.", "default": 1 } } }, "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 } } } } } } } } } }