{ "openapi": "3.0.1", "info": { "title": "Short-term Rental Analyzer: Airbnb vs Long-term Rent", "description": "Turns Airbnb scraper results into nightly-rate market reports and, for homes for sale, the occupancy needed for Airbnb to beat long-term rent. Pairs with Zillow, Realtor.com and Redfin scrapers.", "version": "1.0", "x-build-id": "F2uZaeM1QIyIcXbYD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kodabloomllc~short-term-rental-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kodabloomllc-short-term-rental-analyzer", "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/kodabloomllc~short-term-rental-analyzer/runs": { "post": { "operationId": "runs-sync-kodabloomllc-short-term-rental-analyzer", "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/kodabloomllc~short-term-rental-analyzer/run-sync": { "post": { "operationId": "run-sync-kodabloomllc-short-term-rental-analyzer", "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": { "airbnbDatasetIds": { "title": "Airbnb scraper results", "type": "array", "description": "Pick one or more datasets from Airbnb Scraper (tri_angle/airbnb-scraper) runs. Run it WITH check-in and check-out dates so prices come back; adding a weekday and a weekend run gives a fairer rate." }, "homeDatasetIds": { "title": "Optional: homes for sale", "type": "array", "description": "Pick Zillow, Realtor.com or Redfin scraper results (same formats as the Real Estate Deal Finder). Then each home gets a break-even occupancy and an Airbnb vs long-term rent comparison. Leave empty for a market report only." }, "occupancyPct": { "title": "Assumed occupancy (%)", "minimum": 5, "maximum": 95, "type": "integer", "description": "Used only for the revenue estimate. Occupancy is not measured from the data.", "default": 50 }, "costSharePct": { "title": "Airbnb extra costs (% of revenue)", "minimum": 0, "maximum": 80, "type": "integer", "description": "Cleaning, supplies, platform fees and management that a long-term rental would not have.", "default": 35 }, "radiusKm": { "title": "Comparable radius (km)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Search radius for comparable Airbnb homes. It doubles automatically when fewer than 5 are found.", "default": 5 }, "airbnbListings": { "title": "Or: Airbnb listings as JSON", "type": "array", "description": "Airbnb Scraper items." }, "homes": { "title": "Or: homes as JSON", "type": "array", "description": "Zillow, Realtor.com or Redfin scraper items." } } }, "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 } } } } } } } } } }