{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper", "description": "Extract Airbnb listing prices, reviews, ratings, amenities, and host info for any city worldwide. Vacation rental and short-term rental market research tool. No login required. AI-ready structured data. JSON, CSV, Excel.", "version": "0.1", "x-build-id": "KZ7UnTYgDg1ovdMaZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~airbnb-listing/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-airbnb-listing", "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/automation-lab~airbnb-listing/runs": { "post": { "operationId": "runs-sync-automation-lab-airbnb-listing", "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/automation-lab~airbnb-listing/run-sync": { "post": { "operationId": "run-sync-automation-lab-airbnb-listing", "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": { "locationQueries": { "title": "Location queries", "type": "array", "description": "Enter one or more locations to search (e.g. \"London\", \"Paris, France\", \"Miami Beach, FL\").", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Use pre-built Airbnb search URLs instead of location names. Copy a filtered search URL from your browser to apply property type, amenity, or other filters not available as input fields.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "checkIn": { "title": "Check-in date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Set a check-in date (YYYY-MM-DD) to get availability data on detail pages. Leave empty to scrape without date filters." }, "checkOut": { "title": "Check-out date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Set a check-out date (YYYY-MM-DD). Must be after check-in date." }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Number of adult guests.", "default": 1 }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Number of children." }, "infants": { "title": "Infants", "minimum": 0, "type": "integer", "description": "Number of infants." }, "pets": { "title": "Pets", "minimum": 0, "type": "integer", "description": "Number of pets." }, "priceMin": { "title": "Minimum price per night", "minimum": 0, "type": "integer", "description": "Only include listings at or above this nightly price." }, "priceMax": { "title": "Maximum price per night", "minimum": 0, "type": "integer", "description": "Only include listings at or below this nightly price." }, "minBeds": { "title": "Minimum beds", "minimum": 0, "type": "integer", "description": "Minimum number of beds." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms." }, "locale": { "title": "Language", "enum": [ "en-US", "en-GB", "de-DE", "fr-FR", "es-ES", "it-IT", "pt-BR", "ja-JP", "ko-KR", "zh-CN", "zh-TW", "nl-NL", "pl-PL", "ru-RU" ], "type": "string", "description": "Language for listing descriptions and labels.", "default": "en-US" }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "JPY", "CNY", "KRW", "BRL", "INR", "MXN", "CHF", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "RUB", "TRY" ], "type": "string", "description": "Currency for prices (e.g. USD, EUR, GBP).", "default": "USD" }, "skipDetailPages": { "title": "Search-only mode", "type": "boolean", "description": "Enable to skip detail pages — much faster and cheaper, but returns less data per listing (no description, amenities, host info, or full photo gallery).", "default": false }, "calendarMonths": { "title": "Calendar months", "minimum": 0, "maximum": 12, "type": "integer", "description": "Number of months of future calendar/availability data to fetch per listing (0-12). Each day includes availability, check-in/check-out eligibility, min/max nights, and price. Set to 0 to disable (default). Only future dates are available.", "default": 0 }, "maxListings": { "title": "Max listings", "minimum": 0, "type": "integer", "description": "Stop after collecting this many listings. Set to 0 for unlimited. Use a small number (e.g. 10) for testing.", "default": 0 }, "maxPricePerNight": { "title": "Max price per night (splitting ceiling)", "minimum": 1, "type": "integer", "description": "Upper bound for the price-range splitting algorithm. The scraper splits price ranges to find all listings. Increase above 10000 only if scraping luxury markets." }, "maxRequestsPerCrawl": { "title": "Max HTTP requests", "type": "integer", "description": "Limit total HTTP requests per run. 0 = unlimited. Only set this if you need to cap resource usage.", "default": 0 } } }, "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 } } } } } } } } } }