{ "openapi": "3.0.1", "info": { "title": "Airbnb Occupancy Scraper — Calendar, Occupancy & Booking Pace", "description": "Airbnb occupancy scraper for public availability calendars. Paste listing URLs or a city search and export occupancy %, blocked nights, min-stay, and booking-pace deltas as JSON — an Airbnb calendar API alternative for STR teams.", "version": "0.1", "x-build-id": "jnHLKVtotF9NmyBaY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawloop~airbnb-occupancy-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawloop-airbnb-occupancy-monitor", "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/crawloop~airbnb-occupancy-monitor/runs": { "post": { "operationId": "runs-sync-crawloop-airbnb-occupancy-monitor", "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/crawloop~airbnb-occupancy-monitor/run-sync": { "post": { "operationId": "run-sync-crawloop-airbnb-occupancy-monitor", "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": { "listings": { "title": "Listings", "type": "array", "description": "Airbnb room URLs or numeric listing IDs (the number in /rooms/). One per line.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Room URLs and/or Airbnb search URLs (e.g. /s/Paris--France/homes). Search pages yield the first results page of listing IDs, then calendars are fetched for each.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "location": { "title": "Location", "type": "string", "description": "City or area name used to build a search URL when you do not have listing IDs yet. Example: Paris, France or Austin, TX." }, "calendarMonths": { "title": "Calendar months", "minimum": 1, "maximum": 12, "type": "integer", "description": "Forward months of availability to read (1–12). Airbnb caps the public calendar at about 12 months.", "default": 12 }, "maxListings": { "title": "Max listings", "minimum": 0, "type": "integer", "description": "Hard cap on listings processed in one run. 0 = unlimited.", "default": 50 }, "includeListingDetails": { "title": "Include listing details", "type": "boolean", "description": "Add title, location, rating, capacity, and host fields harvested from the public room page.", "default": true }, "includeCalendar": { "title": "Include daily calendar", "type": "boolean", "description": "Attach the per-day availability array (date, available, check-in/out, min/max nights, price when present).", "default": true }, "monitor": { "title": "Monitor booking pace", "type": "boolean", "description": "Compare this run to the previous run on the same Actor (same default KV store) and emit newly unavailable / newly available night counts. First run has no pace yet.", "default": false }, "currency": { "title": "Currency", "type": "string", "description": "ISO currency code requested from Airbnb. Nightly calendar prices are often null for anonymous reads; occupancy does not depend on price.", "default": "USD" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is recommended. Airbnb often blocks datacenter IPs before the calendar GraphQL responds.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }