{ "openapi": "3.0.1", "info": { "title": "Airbnb Revenue Scraper", "description": "Extract Airbnb listings with occupancy rates and revenue estimates. See nights booked over the next 30, 60 and 90 days, monthly and annual revenue per listing, rental licence numbers, host insights, amenities, photos and house rules. For investors, property managers and market researchers.", "version": "1.1", "x-build-id": "HiVdZAHvCXiQ2a27y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~airbnb-revenue-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-airbnb-revenue-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/brilliant_gum~airbnb-revenue-scraper/runs": { "post": { "operationId": "runs-sync-brilliant_gum-airbnb-revenue-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/brilliant_gum~airbnb-revenue-scraper/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-airbnb-revenue-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", "required": [ "location" ], "properties": { "location": { "title": "Location", "type": "string", "description": "City or area to search (e.g., 'Berlin, Germany', 'Paris', 'New York')" }, "dataLevel": { "title": "Data Package", "enum": [ "basic", "standard", "full" ], "type": "string", "description": "Choose how much data to collect:\n• BASIC ($5/1000) - title, price, rating, location, main photo\n• STANDARD ($15/1000) - + host info, amenities, house rules, 5 photos, host email if found\n• FULL ($30/1000) - + all photos, detailed data, host contact", "default": "basic" }, "maxListings": { "title": "Maximum Listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of listings to scrape. Leave empty for all available.", "default": 100 }, "checkIn": { "title": "Check-in Date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Check-in date (YYYY-MM-DD). Optional - affects pricing." }, "checkOut": { "title": "Check-out Date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Check-out date (YYYY-MM-DD). Optional - affects pricing." }, "guests": { "title": "Number of Guests", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of guests (adults + children)", "default": 1 }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Minimum price per night in selected currency" }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Maximum price per night in selected currency" }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "JPY", "CHF" ], "type": "string", "description": "Currency for prices", "default": "USD" }, "roomType": { "title": "Room Type", "type": "array", "description": "Filter by room type", "items": { "type": "string", "enum": [ "Entire home/apt", "Private room", "Shared room", "Hotel room" ] }, "default": [] }, "superhostOnly": { "title": "Superhost Only", "type": "boolean", "description": "Show only listings from Superhosts", "default": false }, "instantBookOnly": { "title": "Instant Book Only", "type": "boolean", "description": "Show only listings with Instant Book enabled", "default": false }, "minBedrooms": { "title": "Minimum Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms" }, "minBathrooms": { "title": "Minimum Bathrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bathrooms" }, "findHostContact": { "title": "Find Host Contact", "type": "boolean", "description": "Try to find host email/website in listing description (STANDARD and FULL only)", "default": true } } }, "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 } } } } } } } } } }