{ "openapi": "3.0.1", "info": { "title": "Airbnb Revenue, Occupancy & ROI Analyzer | $5/1K", "description": "Analyze Airbnb listings or discover market comparables, then estimate weekly, monthly and annual revenue, occupancy, ADR, RevPAR, NOI, cap rate, cash-on-cash ROI and opportunity ranking.", "version": "1.0", "x-build-id": "Td7wC0ToJQYpW58bW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~airbnb-revenue-occupancy-roi-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-airbnb-revenue-occupancy-roi-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/apivault_labs~airbnb-revenue-occupancy-roi-analyzer/runs": { "post": { "operationId": "runs-sync-apivault_labs-airbnb-revenue-occupancy-roi-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/apivault_labs~airbnb-revenue-occupancy-roi-analyzer/run-sync": { "post": { "operationId": "run-sync-apivault_labs-airbnb-revenue-occupancy-roi-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": { "mode": { "title": "Analysis mode", "enum": [ "listing", "market" ], "type": "string", "description": "Analyze supplied listing URLs or discover and rank comparable listings for a location.", "default": "listing" }, "listingUrls": { "title": "Airbnb listing URLs or room IDs", "type": "array", "description": "Public Airbnb room links or numeric listing IDs. One analysis row is returned per successful listing.", "items": { "type": "string" } }, "searchLocation": { "title": "Market location", "type": "string", "description": "City, neighborhood or destination used to discover public comparable listings in market mode.", "default": "" }, "maxComparableListings": { "title": "Maximum comparable listings", "minimum": 3, "maximum": 20, "type": "integer", "description": "Number of discovered properties to analyze and rank in market mode.", "default": 10 }, "searchBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional minimum bedroom filter for market comparable discovery. Use 0 for any.", "default": 0 }, "searchGuests": { "title": "Guests", "minimum": 0, "maximum": 30, "type": "integer", "description": "Optional guest-count filter for market comparable discovery. Use 0 for Airbnb defaults.", "default": 0 }, "calendarMonths": { "title": "Forward calendar months", "minimum": 1, "maximum": 12, "type": "integer", "description": "Analyze 1–12 months of forward availability. Longer windows improve seasonality coverage.", "default": 6 }, "currency": { "title": "Currency", "minLength": 3, "maxLength": 3, "type": "string", "description": "Three-letter currency requested for published Airbnb prices and used for your financial assumptions.", "default": "USD" }, "nightlyRateOverride": { "title": "Nightly rate override", "minimum": 0, "type": "number", "description": "Optional ADR assumption. Set 0 to use published forward calendar prices.", "default": 0 }, "bookingShareOfBlockedPercent": { "title": "Blocked nights that are bookings, %", "minimum": 0, "maximum": 100, "type": "number", "description": "Blocked nights may also be owner blocks or maintenance. This assumption converts the public blocked-night rate into estimated occupancy.", "default": 75 }, "averageStayNights": { "title": "Average stay length", "minimum": 1, "maximum": 365, "type": "number", "description": "Average booked nights per reservation, used for cleaning revenue and cost modeling.", "default": 3 }, "cleaningFeeRevenuePerStay": { "title": "Cleaning fee charged per stay", "minimum": 0, "type": "number", "description": "Cleaning fee revenue collected from the guest for each estimated reservation.", "default": 0 }, "cleaningCostPerStay": { "title": "Cleaning cost per stay", "minimum": 0, "type": "number", "description": "Your cleaning expense for each estimated reservation.", "default": 0 }, "platformFeePercent": { "title": "Platform fee, %", "minimum": 0, "maximum": 100, "type": "number", "description": "Estimated booking-platform fee as a percentage of gross revenue.", "default": 3 }, "managementFeePercent": { "title": "Property management, %", "minimum": 0, "maximum": 100, "type": "number", "description": "Property-management cost as a percentage of gross revenue.", "default": 15 }, "maintenancePercent": { "title": "Maintenance reserve, %", "minimum": 0, "maximum": 100, "type": "number", "description": "Maintenance and replacement reserve as a percentage of gross revenue.", "default": 5 }, "utilitiesMonthly": { "title": "Utilities per month", "minimum": 0, "type": "number", "description": "Average monthly utilities paid by the property owner.", "default": 300 }, "insuranceAnnual": { "title": "Insurance per year", "minimum": 0, "type": "number", "description": "Annual insurance cost for the property.", "default": 1500 }, "propertyTaxAnnual": { "title": "Property tax per year", "minimum": 0, "type": "number", "description": "Annual property-tax expense.", "default": 0 }, "hoaMonthly": { "title": "HOA per month", "minimum": 0, "type": "number", "description": "Monthly homeowners-association or building fee.", "default": 0 }, "mortgageMonthly": { "title": "Mortgage payment per month", "minimum": 0, "type": "number", "description": "Debt service is excluded from NOI and included in annual cash flow and cash-on-cash return.", "default": 0 }, "purchasePrice": { "title": "Purchase price", "minimum": 0, "type": "number", "description": "Required for cap rate and acquisition return metrics. Set 0 for operations-only analysis.", "default": 0 }, "downPaymentPercent": { "title": "Down payment, %", "minimum": 0, "maximum": 100, "type": "number", "description": "Down payment as a percentage of purchase price, used to calculate cash invested.", "default": 20 }, "closingCosts": { "title": "Closing costs", "minimum": 0, "type": "number", "description": "One-time acquisition closing costs included in cash invested.", "default": 0 }, "furnishingCosts": { "title": "Furnishing and startup costs", "minimum": 0, "type": "number", "description": "One-time furnishing and launch costs included in cash invested.", "default": 0 }, "emitProjectionRows": { "title": "Add CSV-friendly projection rows", "type": "boolean", "description": "Also emit each weekly and monthly projection as a separate uncharged Dataset row for CSV and spreadsheet workflows.", "default": false }, "previousSnapshots": { "title": "Previous analysis snapshots", "type": "array", "description": "Optional prior property metrics used to calculate occupancy, ADR and annual-revenue changes and monitoring alerts.", "items": { "type": "object", "additionalProperties": false, "properties": { "listingId": { "title": "Listing ID", "type": "string", "description": "Airbnb listing ID from a previous result." }, "blockedNightRatePercent": { "title": "Blocked-night rate", "type": "number", "description": "Previous blocked-night rate." }, "estimatedOccupancyRatePercent": { "title": "Estimated occupancy", "type": "number", "description": "Previous estimated occupancy rate." }, "averageDailyRateEstimate": { "title": "ADR", "type": "number", "description": "Previous ADR estimate." }, "annualGrossRevenueEstimate": { "title": "Annual revenue", "type": "number", "description": "Previous annual gross-revenue estimate." }, "scrapedAt": { "title": "Snapshot timestamp", "type": "string", "description": "Previous snapshot timestamp." } }, "required": [ "listingId" ] }, "default": [] }, "maxConcurrency": { "title": "Processing concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Parallel property analyses. The default balances speed and upstream reliability.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is recommended for public Airbnb availability.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "countryCode": "US" } } } }, "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 } } } } } } } } } }