{ "openapi": "3.0.1", "info": { "title": "Airbnb Listings Scraper", "description": "Scrape public Airbnb search results and listing detail pages — titles, full descriptions, prices, ratings, amenities, hosts, and photo galleries. Honest completeness and pagination flags; incomplete rows are never billed.", "version": "1.0", "x-build-id": "6Y5v5kbhZtZNvh04q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rainminer~airbnb-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rainminer-airbnb-listings-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/rainminer~airbnb-listings-scraper/runs": { "post": { "operationId": "runs-sync-rainminer-airbnb-listings-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/rainminer~airbnb-listings-scraper/run-sync": { "post": { "operationId": "run-sync-rainminer-airbnb-listings-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", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Airbnb homes search URLs (for example https://www.airbnb.com/s/Paris--France/homes) and/or listing detail URLs (https://www.airbnb.com/rooms/…). Filters already in the URL are kept; optional filter fields below are merged when set.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locationQueries": { "title": "Location Queries", "type": "array", "description": "List of location queries to scrape (tri_angle/airbnb-scraper compatible). Example: London, Paris, Manchester.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of listings to return per start URL or location query. Takes precedence over maxResults when both are set.", "default": 5 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Alias of maxItems for tri_angle/airbnb-scraper compatibility. Ignored when maxItems is set." }, "checkIn": { "title": "Check-In Date", "type": "string", "description": "Date must be in YYYY-MM-DD format with zero-padded month and day, e.g. 2026-09-01." }, "checkOut": { "title": "Check-Out Date", "type": "string", "description": "Date must be in YYYY-MM-DD format with zero-padded month and day, e.g. 2026-09-05." }, "locale": { "title": "Locale", "enum": [ "en-US", "az-AZ", "id-ID", "bs-BA", "ca-ES", "cs-CZ", "sr-ME", "da-DK", "de-DE", "de-AT", "de-CH", "de-LU", "et-EE", "en-AU", "en-CA", "en-GB", "en-GY", "en-IN", "en-IE", "en-NZ", "en-SG", "en-AE", "es-AR", "es-BZ", "es-BO", "es-CL", "es-CO", "es-CR", "es-EC", "es-SV", "es-ES", "es-US", "es-GT", "es-HN", "es-419", "es-MX", "es-NI", "es-PA", "es-PY", "es-PE", "es-VE", "fr-BE", "fr-CA", "fr-FR", "fr-CH", "fr-LU", "ga-IE", "hr-HR", "xh-ZA", "zu-ZA", "is-IS", "it-IT", "it-CH", "sw-XX", "lv-LV", "lt-LT", "hu-HU", "mt-MT", "ms-MY", "nl-BE", "nl-NL", "no-NO", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "sq-AL", "sk-SK", "sl-SI", "sr-RS", "fi-FI", "sv-SE", "tl-PH", "vi-VN", "tr-TR", "el-GR", "bg-BG", "mk-MK", "ru-RU", "uk-UA", "ka-GE", "hy-AM", "he-IL", "ar-XX", "hi-IN", "th-TH", "ko-KR", "ja-JP", "zh-US", "zh-TW-US", "zh-CN", "zh-HK", "zh-TW" ], "type": "string", "description": "Localized results in this locale will be extracted (language and region).", "default": "en-US" }, "currency": { "title": "Currency", "enum": [ "USD", "CZK", "AUD", "BRL", "BGN", "CAD", "CLP", "CNY", "COP", "CRC", "HRK", "DKK", "EGP", "AED", "EUR", "GHS", "HKD", "HUF", "INR", "IDR", "ILS", "JPY", "KZT", "KES", "MYR", "MXN", "MAD", "TWD", "NZD", "NOK", "PEN", "PHP", "PLN", "GBP", "QAR", "RON", "SAR", "SGD", "ZAR", "KRW", "SEK", "CHF", "THB", "TRY", "UGX", "UAH", "UYU", "VND" ], "type": "string", "description": "Currency that will be extracted for prices.", "default": "USD" }, "priceMin": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Minimum price filter applied to search URLs / location queries." }, "priceMax": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Maximum price filter applied to search URLs / location queries." }, "minBeds": { "title": "Minimum Beds", "minimum": 0, "type": "integer", "description": "Minimum beds filter." }, "minBedrooms": { "title": "Minimum Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum bedrooms filter." }, "minBathrooms": { "title": "Minimum Bathrooms", "minimum": 0, "type": "integer", "description": "Minimum bathrooms filter." }, "adults": { "title": "Adults", "minimum": 0, "type": "integer", "description": "Number of adults for search pricing/availability context." }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Number of children for search pricing/availability context." }, "infants": { "title": "Infants", "minimum": 0, "type": "integer", "description": "Number of infants for search pricing/availability context." }, "pets": { "title": "Pets", "minimum": 0, "type": "integer", "description": "Number of pets for search pricing/availability context." }, "enrichUserProfiles": { "title": "Enrich User Profiles", "type": "boolean", "description": "Accepted for tri_angle/airbnb-scraper compatibility. This Actor already exports public host signals from the listing page and does not perform a separate host-profile crawl.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Defaults to no proxy; enable Apify Proxy (datacenter or residential) if you see blocks in your region." } } }, "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 } } } } } } } } } }