{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper Pro - Vacation Rental Market Intelligence", "description": "Scrape Airbnb search results and listing details with various filters - no API key required for basic property data extraction", "version": "0.0", "x-build-id": "0E0RpmpOiUfrFsQBa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/red.cars~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-red.cars-airbnb-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/red.cars~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-red.cars-airbnb-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/red.cars~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-red.cars-airbnb-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": { "mode": { "title": "Extraction Mode", "enum": [ "search", "details" ], "type": "string", "description": "Choose what type of data to extract", "default": "search" }, "location": { "title": "Search Location", "type": "string", "description": "Enter the city, neighborhood, or address you want to analyze for investment opportunities", "default": "New York, NY" }, "listingIds": { "title": "Property IDs (Details Mode)", "type": "array", "description": "List of Airbnb property IDs for detailed analysis (only used in Details mode)", "items": { "type": "string" }, "default": [ "50633275", "45678912" ] }, "checkin": { "title": "Check-in Date (Optional)", "type": "string", "description": "Format: YYYY-MM-DD. Leave empty for general market analysis", "default": "" }, "checkout": { "title": "Check-out Date (Optional)", "type": "string", "description": "Format: YYYY-MM-DD. Leave empty for general market analysis", "default": "" }, "adults": { "title": "Number of Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests for pricing calculations", "default": 2 }, "children": { "title": "Number of Children", "minimum": 0, "maximum": 16, "type": "integer", "description": "Number of children for family-friendly property analysis", "default": 0 }, "minPrice": { "title": "Minimum Price Per Night", "minimum": 0, "type": "integer", "description": "Filter properties by minimum nightly rate (USD)" }, "maxPrice": { "title": "Maximum Price Per Night", "minimum": 0, "type": "integer", "description": "Filter properties by maximum nightly rate (USD)" }, "maxResults": { "title": "Number of Properties to Analyze", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many properties to collect for your market research (large-scale market analysis now supported)", "default": 5 }, "enableBusinessIntelligence": { "title": "Investment Analysis", "type": "boolean", "description": "Add property investment scoring, market analysis, and business insights to help evaluate opportunities", "default": false }, "proxyType": { "title": "Proxy Reliability Level", "enum": [ "DATACENTER", "RESIDENTIAL" ], "type": "string", "description": "Choose your preferred balance of cost vs reliability. Standard (Datacenter) is faster; Premium (Residential) is most reliable for high-security targets.", "default": "RESIDENTIAL" }, "debugMode": { "title": "Debug Mode (Self-Test)", "type": "boolean", "description": "Enable minimal extraction for health checks and testing. Guarantees success within 300s.", "default": false }, "outputFormat": { "title": "Export Format", "enum": [ "json", "csv", "markdown", "excel", "salesforce", "hubspot" ], "type": "string", "description": "Choose how you want to receive your property data. Use 'markdown' for token-efficient LLM-ready real estate cards.", "default": "json" } } }, "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 } } } } } } } } } }