{ "openapi": "3.0.1", "info": { "title": "AirDNA Scraper: STR Market Revenue, Occupancy, ADR & YoY Trends", "description": "Extract AirDNA's public short-term-rental market data: active listings, annual revenue, occupancy, ADR, RevPAR, and real year-over-year revenue and occupancy trend deltas. No AirDNA account, password, or API key required. Monitor mode flags NEW, UPDATED, and CURRENT markets. $0.0025/market.", "version": "0.1", "x-build-id": "pIFdaokGs90jp8osa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~airdna-market-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-airdna-market-data-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/getascraper~airdna-market-data-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-airdna-market-data-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/getascraper~airdna-market-data-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-airdna-market-data-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": { "marketUrls": { "title": "Market Overview URLs", "type": "array", "description": "Direct AirDNA market overview page URLs, e.g. https://www.airdna.co/vacation-rental-data/app/us/california/los-angeles/overview. This is the cheapest and most reliable path since it skips browse-index discovery entirely, and it reads AirDNA's public market data with no AirDNA account or login required. Leave empty to discover markets instead using the filters below.", "default": [ { "url": "https://www.airdna.co/vacation-rental-data/app/us/california/los-angeles/overview" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "countries": { "title": "Countries", "type": "array", "description": "Country slugs to browse for markets when Market Overview URLs is empty, e.g. \"us\". Matches AirDNA's own URL slugs (https://www.airdna.co/vacation-rental-data/app/{country}). Leave empty to skip country-level discovery.", "default": [], "items": { "type": "string" } }, "states": { "title": "States / Regions", "type": "array", "description": "State or region slugs to filter discovery within the selected countries, e.g. \"california\". Matches AirDNA's own URL slugs. Leave empty to include every state found for each selected country.", "default": [], "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City slugs to filter discovery within the selected states, e.g. \"los-angeles\". Matches AirDNA's own URL slugs. Leave empty to include every city found for each selected state.", "default": [], "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "AirDNA sits behind a Cloudflare managed challenge that a real browser clears immediately, so Apify's standard datacenter proxy is enough and is kept as the default here to hold costs down. If runs start failing, switch this to the RESIDENTIAL group in the picker as a fallback, no other change is needed.", "default": { "useApifyProxy": true } }, "maxItems": { "title": "Max Markets", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of market pages to scrape in this run. Each market is a full browser page load, so keep this modest for a quick run; raise it once you know how long your own market list takes.", "default": 12 }, "incrementalMonitorMode": { "title": "Enable Monitor Mode", "type": "boolean", "description": "When enabled, each market's core metrics (active listings, annual revenue, occupancy, average daily rate, RevPAR) are fingerprinted and compared against the previous run, and every item is tagged NEW, UPDATED, or CURRENT. AirDNA republishes market numbers on a monthly cadence, so scheduling this actor with monitor mode on surfaces genuine month-over-month revenue and occupancy changes instead of a one-off snapshot.", "default": false }, "monitorStateName": { "title": "Monitor State Name", "type": "string", "description": "Name of the stored state bucket used by Monitor Mode. Use different names to run multiple independent monitors (for example, one per market portfolio) without their stored fingerprints overwriting each other. Ignored when Monitor Mode is off.", "default": "default" } } }, "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 } } } } } } } } } }