{
"openapi": "3.0.1",
"info": {
"title": "Airbnb Occupancy, ADR & Market Report 📈: AirDNA Alternative",
"description": "Turn any Airbnb search into occupancy, ADR, RevPAR and revenue yield data, with comp-set percentile ranks and a market-wide report. Pay per pull from $0.004/listing, no subscription.",
"version": "0.1",
"x-build-id": "gLGQpeVmo1hn2dmnc"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/tagadanar~airbnb-str-yield/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-tagadanar-airbnb-str-yield",
"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/tagadanar~airbnb-str-yield/runs": {
"post": {
"operationId": "runs-sync-tagadanar-airbnb-str-yield",
"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/tagadanar~airbnb-str-yield/run-sync": {
"post": {
"operationId": "run-sync-tagadanar-airbnb-str-yield",
"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",
"required": [
"searchUrls"
],
"properties": {
"searchUrls": {
"title": "Airbnb search URLs",
"type": "array",
"description": "Paste one or more Airbnb search-results URLs — build the search on airbnb.fr (or .com) for your area/filters and copy the page URL, e.g. https://www.airbnb.fr/s/Paris/homes. The actor reads every listing in the area and computes occupancy, ADR and RevPAR from each one's public availability calendar.",
"items": {
"type": "string"
}
},
"fetchCalendar": {
"title": "Compute yield (fetch availability calendars)",
"type": "boolean",
"description": "Fetch each listing's public availability calendar and compute occupancy / RevPAR / seasonality. Turn off for a fast listings-only scrape (ADR + ratings, no yield).",
"default": true
},
"calendarMonths": {
"title": "Calendar months ahead",
"minimum": 1,
"maximum": 12,
"type": "integer",
"description": "How many months of forward availability to read per listing (drives the annual occupancy & seasonality curve).",
"default": 12
},
"marketReport": {
"title": "Add a market-level yield report",
"type": "boolean",
"description": "Also output one aggregate row per market: median/quartile ADR, occupancy and RevPAR across all analyzed listings — the AirDNA-style market snapshot.",
"default": true
},
"onlyPrivateHost": {
"title": "Owner-hosted only (particuliers)",
"type": "boolean",
"description": "Keep only listings hosted by a private individual (particulier), dropping professional property managers.",
"default": false
},
"minAdr": {
"title": "Minimum nightly rate (€)",
"minimum": 0,
"type": "integer",
"description": "Keep only listings with an advertised nightly rate at or above this."
},
"maxAdr": {
"title": "Maximum nightly rate (€)",
"minimum": 0,
"type": "integer",
"description": "Keep only listings with an advertised nightly rate at or below this."
},
"minRating": {
"title": "Minimum rating",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Keep only listings with at least this average rating (whole number, out of 5)."
},
"minReviews": {
"title": "Minimum reviews",
"minimum": 0,
"type": "integer",
"description": "Keep only listings with at least this many reviews (a proxy for booking history / maturity)."
},
"propertyTypes": {
"title": "Property types",
"type": "array",
"description": "Keep only listings whose type contains one of these words (e.g. Appartement, Maison, Studio). Empty = all.",
"default": [],
"items": {
"type": "string"
}
},
"monitorMode": {
"title": "Monitor mode (new listings only)",
"type": "boolean",
"description": "Remember what previous runs reported (per monitorName) and return only new listings. Schedule daily for a live feed of fresh STR supply — you're charged for new listings only.",
"default": false
},
"monitorName": {
"title": "Monitor name",
"type": "string",
"description": "Name for this watch's memory of already-seen listings. Use a distinct name per saved search (e.g. paris-11e).",
"default": "default"
},
"webhookUrl": {
"title": "Slack / webhook URL",
"type": "string",
"description": "Optional. A Slack incoming-webhook URL (or any endpoint) that receives a digest of the new listings — pairs with monitor mode + a daily schedule."
},
"maxListings": {
"title": "Max listings to analyze",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Stop after analyzing this many unique listings across all search URLs.",
"default": 300
}
}
},
"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
}
}
}
}
}
}
}
}
}
}