{ "openapi": "3.0.1", "info": { "title": "Airbnb Calendar, Occupancy & Pricing Scraper — 365-Day STR A", "description": "Scrape Airbnb listings with 365-day forward calendar availability, occupancy rates (30d/90d/365d), nightly rates, fee & discount breakdowns, sub-ratings, and Superhost data without a browser.", "version": "0.1", "x-build-id": "Zr1uCqDRtz7vuS3VL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spotless_studios~airbnb-calendar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spotless_studios-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/spotless_studios~airbnb-calendar-scraper/runs": { "post": { "operationId": "runs-sync-spotless_studios-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/spotless_studios~airbnb-calendar-scraper/run-sync": { "post": { "operationId": "run-sync-spotless_studios-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": { "locations": { "title": "Search locations", "type": "array", "description": "Cities, regions, or neighborhoods to search on Airbnb, e.g. \"Austin, TX\", \"Scottsdale, AZ\", \"Joshua Tree, CA\".", "items": { "type": "string" } }, "roomIds": { "title": "Direct room IDs or URLs", "type": "array", "description": "Optional Airbnb room IDs (e.g. \"48867583\") or full https://www.airbnb.com/rooms/ URLs to scrape directly.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date (YYYY-MM-DD)", "type": "string", "description": "Optional check-in date for search quote pricing, e.g. \"2026-11-15\".", "default": "" }, "checkOut": { "title": "Check-out date (YYYY-MM-DD)", "type": "string", "description": "Optional check-out date for search quote pricing, e.g. \"2026-11-20\".", "default": "" }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests for search queries.", "default": 2 }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter ISO currency code for prices, e.g. \"USD\", \"EUR\", \"GBP\", \"CAD\", \"AUD\".", "default": "USD" }, "calendarMonths": { "title": "Forward calendar months (0-12)", "minimum": 0, "maximum": 12, "type": "integer", "description": "Number of forward months of daily availability and minimum-stay rules to fetch per listing (12 = full 365-day forward calendar; 0 = skip calendar).", "default": 12 }, "enrichRoomDetails": { "title": "Enrich full room & host details", "type": "boolean", "description": "Fetch each listing's room page for host ID, Superhost flag, 6 sub-ratings (cleanliness, accuracy, check-in, communication, location, value), person capacity, and full description.", "default": true }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep only listings rated at least this many stars (0-5)." }, "minReviews": { "title": "Minimum reviews", "minimum": 0, "type": "integer", "description": "Keep only listings with at least this many reviews." }, "onlySuperhosts": { "title": "Only Superhosts", "type": "boolean", "description": "Keep only listings hosted by an Airbnb Superhost.", "default": false }, "onlyGuestFavorites": { "title": "Only Guest Favorites", "type": "boolean", "description": "Keep only listings with the Airbnb Guest Favorite badge.", "default": false }, "includeKeywords": { "title": "Include keywords", "type": "array", "description": "Keep listings whose title, subtitle, or description contain these words. /regex/ supported.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop listings containing any of these words or /regex/.", "items": { "type": "string" } }, "keywordMatch": { "title": "Include keyword logic", "enum": [ "any", "all" ], "type": "string", "description": "Require any or all include keywords.", "default": "any" }, "onlyNewItems": { "title": "Only new listings (monitoring mode)", "type": "boolean", "description": "Remember listings from previous runs and save only ones not seen before.", "default": false }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Separate memory per saved search.", "default": "default" }, "maxResults": { "title": "Max listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after saving this many Airbnb listings.", "default": 36 }, "outputPreset": { "title": "Data preset", "enum": [ "full", "lean", "contacts" ], "type": "string", "description": "Quickly choose how much data to save per record: full record, lean summary, or contact & social links only.", "default": "full" }, "outputFields": { "title": "Output fields", "type": "array", "description": "Save only these fields, in this order (e.g. name, website, country, tier, minimumBudgetUsd, hourlyDesignRateUsd, profileUrl). Supports nested dot-paths (e.g. makers.username). Empty keeps all fields from the selected preset.", "items": { "type": "string" } }, "excludeFields": { "title": "Exclude fields", "type": "array", "description": "Remove specific fields (or nested dot-paths) from each saved record to keep datasets compact.", "items": { "type": "string" } }, "includeEmptyFields": { "title": "Keep empty / null fields", "type": "boolean", "description": "When turned off, strips null, empty strings, empty arrays, and empty objects from every saved record.", "default": true }, "requiredFields": { "title": "Required non-empty fields", "type": "array", "description": "Only save (and only pay for) records where every listed field or dot-path has a non-empty value (e.g. website, inquiryEmail).", "items": { "type": "string" } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Pages fetched in parallel.", "default": 6 }, "maxRequestRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries per request.", "default": 4 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Timeout per request.", "default": 45 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional; not usually needed.", "default": { "useApifyProxy": false } }, "proxyEscalation": { "title": "Auto-escalate proxies when blocked", "type": "boolean", "description": "If the site blocks the run, automatically step up from a direct connection to Apify datacenter proxy, then residential proxy, only for the blocked site. Turn off to use exactly the proxy above.", "default": true } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }