{ "openapi": "3.0.1", "info": { "title": "Airbnb Calendar & Availability Scraper", "description": "Scrapes Airbnb calendar availability, pricing, and occupancy data for 1-12 months forward. Supports listing IDs, URLs, search URLs, bounding boxes, and location names.", "version": "1.0", "x-build-id": "LjmyOdyHrVFFiOkmn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/integrative_tangent~airbnb-calendar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-integrative_tangent-airbnb-calendar-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/integrative_tangent~airbnb-calendar-scraper/runs": { "post": { "operationId": "runs-sync-integrative_tangent-airbnb-calendar-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/integrative_tangent~airbnb-calendar-scraper/run-sync": { "post": { "operationId": "run-sync-integrative_tangent-airbnb-calendar-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": { "listingIds": { "title": "Listing IDs", "type": "array", "description": "Airbnb listing IDs to scrape calendars for. Example: [\"1415214853332746816\", \"1060090216136524847\"]. Always provide as strings to avoid precision loss.", "items": { "type": "string" } }, "urls": { "title": "Listing URLs", "type": "array", "description": "Airbnb listing page URLs. Example: [\"https://www.airbnb.com/rooms/1415214853332746816\"]", "items": { "type": "string" } }, "searchUrl": { "title": "Search URL", "type": "string", "description": "An Airbnb search results page URL. The actor will extract the map bounding box and discover all listings in that area. Example: \"https://www.airbnb.com/s/homes?ne_lat=19.8&ne_lng=-70.35&sw_lat=19.72&sw_lng=-70.48&search_by_map=true\"" }, "boundingBox": { "title": "Bounding Box", "type": "object", "description": "Geographic bounding box to search for listings. Provide as JSON: { \"ne_lat\": 18.75, \"ne_lng\": -68.30, \"sw_lat\": 18.50, \"sw_lng\": -68.55 }" }, "location": { "title": "Location", "type": "string", "description": "Location name to search. The actor will resolve this to a geographic area. Example: \"Las Terrenas, Dominican Republic\"" }, "calendarMonths": { "title": "Calendar Months", "minimum": 1, "maximum": 12, "type": "integer", "description": "Number of months of calendar data to scrape (1-12).", "default": 12 }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "MXN", "DOP", "BRL", "COP" ], "type": "string", "description": "Currency code for pricing data.", "default": "USD" }, "maxListings": { "title": "Max Listings", "minimum": 0, "type": "integer", "description": "Maximum number of listings to process. Set to 0 for unlimited. Useful for testing.", "default": 0 }, "requestsPerSecond": { "title": "Requests Per Second", "minimum": 0.5, "maximum": 5, "type": "number", "description": "Starting request rate. The actor adapts automatically — backs off on rate limits and speeds up when safe. Range: 0.5-5.", "default": 2 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Configure proxy settings. Recommended: use Apify Proxy with residential group for best results." } } }, "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 } } } } } } } } } }