{ "openapi": "3.0.1", "info": { "title": "AirDNA Scraper — STR Market Data & Airbnb Deals", "description": "Scrape AirDNA short-term-rental market metrics (revenue, occupancy, ADR, RevPAR, Market Score) and top Airbnb/Vrbo property deals from airdna.co.", "version": "0.0", "x-build-id": "7LjnDktPckTZF2Gp8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~airdna-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-airdna-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/memo23~airdna-scraper/runs": { "post": { "operationId": "runs-sync-memo23-airdna-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/memo23~airdna-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-airdna-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": { "mode": { "title": "Output mode", "enum": [ "markets", "properties", "both" ], "type": "string", "description": "markets = one row per market (active listings, revenue, occupancy, ADR, RevPAR, Market Score). properties = one row per Airbnb/Vrbo listing on that market's deals page (up to 100 per market). both = both kinds in one dataset, separable by the entityType field.", "default": "markets" }, "startUrls": { "title": "AirDNA URLs", "type": "array", "description": "Paste any airdna.co market URL (https://www.airdna.co/vacation-rental-data/app/us/california/los-angeles/overview) or deals URL (https://www.airdna.co/top/us/california/los-angeles). Either form works for either mode — the actor rewrites the link to whichever page it needs.", "items": { "type": "string" } }, "country": { "title": "Country slug", "type": "string", "description": "Two-letter country slug exactly as it appears in AirDNA URLs: us, gb, fr, es, it, de, id, mx, ca, au. Scrapes every market AirDNA publishes for that country." }, "region": { "title": "Region / state slug", "type": "string", "description": "Region or state slug as it appears in AirDNA URLs, e.g. california, florida, texas, london, ile-de-france. Combine with the country slug to avoid matching a same-named region elsewhere." }, "searchTerms": { "title": "Market names", "type": "array", "description": "Market names in plain text, e.g. Los Angeles, Big Bear Lake, Paris. Each is resolved against AirDNA's published market slugs, with exact matches ranked ahead of partial ones and at most 25 markets returned per term.", "items": { "type": "string" } }, "scrapeAllMarkets": { "title": "Scrape every market worldwide", "type": "boolean", "description": "Walk all ~24,500 markets AirDNA publishes, ignoring the country, region and name filters above. maxItems is the only brake on a run this size, so set it deliberately before switching this on.", "default": false }, "maxItems": { "title": "Maximum items", "minimum": 1, "type": "integer", "description": "Hard cap on dataset rows. Free-plan users are additionally capped at 100 rows per run.", "default": 1000 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many AirDNA pages to fetch at once. 10 is a good balance; raise it for large runs if your memory allocation allows.", "default": 10 }, "minConcurrency": { "title": "Minimum concurrency", "minimum": 1, "type": "integer", "description": "Lower bound on parallel requests. Only applies to the Crawlee branch.", "default": 1 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "type": "integer", "description": "How many times to retry a page that fails to load. Only applies to the Crawlee branch — the default pipeline runs its own six-attempt ladder across three HTTP stacks.", "default": 5 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy settings. Leave unset to connect directly." } } }, "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 } } } } } } } } } }