{ "openapi": "3.0.1", "info": { "title": "Airbnb Occupancy & Pricing Scraper", "description": "Scrape Airbnb occupancy and pricing from public listing calendars. Use for STR comps, occupancy upper bound, ADR, and RevPAR. Do not use for host iCal exports — see airbnb-calendar-availability-scraper. Returns one occupancy report per listing. Charged $0.006 per listing report.", "version": "0.1", "x-build-id": "cm8sdecea4IQ9w6iG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~airbnb-occupancy-pricing-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-airbnb-occupancy-pricing-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/khadinakbar~airbnb-occupancy-pricing-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-airbnb-occupancy-pricing-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/khadinakbar~airbnb-occupancy-pricing-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-airbnb-occupancy-pricing-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 analyze, one per row. Example: 12937 (the number in /rooms/12937). Defaults to none when you only pass startUrls or a location. NOT an iCal export URL — use airbnb-calendar-availability-scraper for authorized calendars.", "items": { "type": "string" } }, "startUrls": { "title": "Listing URLs", "type": "array", "description": "Public Airbnb listing URLs to analyze. Example: https://www.airbnb.com/rooms/12937. Combined with listingIds and deduped. Max 100 unique listings per run. NOT search URLs and NOT iCal links.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "location": { "title": "Location search", "type": "string", "description": "City or area used only when no listing IDs/URLs are provided. Example: Austin, TX or Bali--Indonesia. Finds public stays then analyzes each calendar. Explicit listing IDs skip this field. NOT a lat/lng pair." }, "calendarMonths": { "title": "Forward calendar months", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many forward months of public availability to request, from 1 to 12. Airbnb caps the horizon around 12 months. Prefill 3 keeps quality tests fast; default 12 for full-year occupancy. Not a historical archive.", "default": 12 }, "maxListings": { "title": "Max listings", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard cap on unique listings processed after dedupe. Defaults to 50, maximum 100. Prefill 1 keeps the quality test cheap. Each saved occupancy report costs $0.006.", "default": 50 }, "includeProfile": { "title": "Include listing profile", "type": "boolean", "description": "When true, attach title, room type, location, rating, capacity, and bedroom counts from the public listing page. Defaults to true. Set false for calendar metrics only. Does not add a second billed event.", "default": true }, "includeDailyCalendar": { "title": "Include daily calendar rows", "type": "boolean", "description": "When true, attach the day-level available/minNights/price array on each listing report. Defaults to false to keep agent output small. Turn on only when you need the raw forward calendar.", "default": false }, "currency": { "title": "Currency", "type": "string", "description": "ISO 4217 currency for price labels Airbnb returns (e.g. USD, EUR, GBP). Defaults to USD. Anonymous calendars often omit nightly prices; occupancy does not depend on this field.", "default": "USD" }, "locale": { "title": "Locale", "type": "string", "description": "Locale passed to Airbnb GraphQL (e.g. en, en-US). Defaults to en. Does not change occupancy math.", "default": "en" }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 4, "type": "integer", "description": "How many listings to analyze in parallel, from 1 to 4. Defaults to 2. Keep low to stay under Airbnb rate limits. Not a monthly request quota.", "default": 2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy used for Airbnb HTTP. Residential is recommended because datacenter ASNs are often fingerprinted. This is not an Airbnb login cookie.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }