{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper — Listings, Prices & Details", "description": "Search Airbnb by location and export clean listing data: prices, ratings, review counts, photos, coordinates, and Guest favorite status. Turn on full details to also get descriptions, amenities, house rules, highlights, and host info. Export to JSON, CSV, or Excel.", "version": "1.0", "x-build-id": "uEKjUZpJWfkNHuxQU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vero-api~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vero-api-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/vero-api~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-vero-api-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/vero-api~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-vero-api-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": { "location": { "title": "Location", "type": "string", "description": "Where do you want to search? Type a city, neighborhood, or region — e.g. \"Paris, France\"." }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Arrival date (YYYY-MM-DD). Add it to get real prices for your trip. Leave empty to browse without dates." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "Departure date (YYYY-MM-DD). Use together with the 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", "minimum": 0, "type": "integer", "description": "Only show places at or above this nightly price (in the chosen currency)." }, "priceMax": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only show places at or below this nightly price (in the chosen currency)." }, "roomTypes": { "title": "Room types", "type": "array", "description": "Pick the kinds of places to include. Leave empty to include them all.", "items": { "type": "string", "enum": [ "Entire home/apt", "Private room", "Hotel room", "Shared room" ], "enumTitles": [ "Entire place", "Private room", "Hotel room", "Shared room" ] } }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Only show places with at least this many bedrooms." }, "minBeds": { "title": "Minimum beds", "minimum": 0, "type": "integer", "description": "Only show places with at least this many beds." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "integer", "description": "Only show places with at least this many bathrooms." }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD", "CHF", "CNY", "JPY", "KRW", "INR", "BRL", "MXN", "AED", "SAR", "QAR", "SGD", "HKD", "TWD", "THB", "MYR", "IDR", "PHP", "VND", "TRY", "ZAR", "NZD", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "RON", "BGN", "UAH", "MAD", "EGP", "GHS", "KES", "UGX", "KZT", "CLP", "COP", "CRC", "PEN", "UYU", "ILS" ], "type": "string", "description": "Currency for all prices.", "default": "USD" }, "locale": { "title": "Language", "enum": [ "ar", "az", "bg", "bs", "ca", "cs", "da", "de", "de-AT", "de-CH", "de-LU", "el", "en", "en-AE", "en-AU", "en-CA", "en-GB", "en-GY", "en-IE", "en-IN", "en-MT", "en-NZ", "en-SG", "en-ZA", "es", "es-AR", "es-BO", "es-BZ", "es-CL", "es-CO", "es-CR", "es-EC", "es-ES", "es-GT", "es-HN", "es-MX", "es-NI", "es-PA", "es-PE", "es-PY", "es-SV", "es-US", "es-VE", "et", "fi", "fr", "fr-BE", "fr-CA", "fr-CH", "fr-LU", "ga", "he", "hi", "hr", "hu", "hy", "id", "is", "it", "it-CH", "ja", "ka", "kn", "ko", "lt", "lv", "mk", "mr", "ms", "mt", "nl", "nl-BE", "no", "pl", "pt", "pt-PT", "ro", "ru", "sk", "sl", "sq", "sr", "sr-ME", "sv", "sw", "th", "tl", "tr", "uk", "vi", "xh", "zh", "zh-HK", "zh-TW", "zh-US", "zu" ], "type": "string", "description": "Language for titles and descriptions.", "default": "en" }, "maxItems": { "title": "Maximum listings", "minimum": 1, "type": "integer", "description": "How many listings you want. Leave the default to get a full page of results.", "default": 100 }, "includeDetails": { "title": "Include full details", "type": "boolean", "description": "Off by default for fast, light results — you still get title, price, rating, reviews, photos, location, and bed info. Turn on to also fetch each place's description, amenities, host, and capacity (this visits each listing, so larger searches take longer).", "default": false } } }, "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 } } } } } } } } } }