{ "openapi": "3.0.1", "info": { "title": "Airbnb Listing Price & Location Finder", "description": "Search Airbnb by location and stay dates for listing price, rating, Superhost and verification status, GPS coordinates, and photos per property.", "version": "2.0", "x-build-id": "zfEcct44bLImtWJsa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nimbryxo-studio~airbnb-listing-price-and-location-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nimbryxo-studio-airbnb-listing-price-and-location-finder", "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/nimbryxo-studio~airbnb-listing-price-and-location-finder/runs": { "post": { "operationId": "runs-sync-nimbryxo-studio-airbnb-listing-price-and-location-finder", "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/nimbryxo-studio~airbnb-listing-price-and-location-finder/run-sync": { "post": { "operationId": "run-sync-nimbryxo-studio-airbnb-listing-price-and-location-finder", "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": { "mode": { "title": "Mode", "enum": [ "search", "details" ], "type": "string", "description": "Search discovers listings by location or map area. Details loads the listing URLs or IDs you provide.", "default": "search" }, "location": { "title": "Location", "type": "string", "description": "City, region, country or neighborhood, e.g. New York, Paris, SoHo. Airbnb's own location lookup validates the name before searching (mode=search)." }, "placeId": { "title": "Airbnb place ID", "type": "string", "description": "Optional Google/Airbnb place ID (e.g. ChIJOwg_06VPwokRYv534QaPC8g). Takes precedence over the resolved location and skips text matching (mode=search)." }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Optional neighborhood to combine with Location, e.g. SoHo + New York (mode=search)." }, "bbox": { "title": "Map bounding box", "type": "object", "description": "Search inside a map rectangle instead of a named location. Use decimal degrees: swLat, swLng (south-west corner) and neLat, neLng (north-east corner), plus an optional zoom (1-22). Example: {\"swLat\": 40.7075, \"swLng\": -74.0135, \"neLat\": 40.7904, \"neLng\": -73.9591, \"zoom\": 13} (mode=search)." }, "listingUrls": { "title": "Listing URLs", "type": "array", "description": "Airbnb room URLs, e.g. https://www.airbnb.com/rooms/23222680 (mode=details).", "items": { "type": "string" } }, "listingIds": { "title": "Listing IDs", "type": "array", "description": "Numeric Airbnb listing IDs, e.g. 23222680. You can mix these with listing URLs (mode=details).", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Stay start date in YYYY-MM-DD format. Leave both dates empty to use Airbnb's displayed quote (search) or to skip the price quote (details)." }, "checkOut": { "title": "Check-out date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Stay end date in YYYY-MM-DD format. Must be after the check-in date." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests (1-16).", "default": 1 }, "children": { "title": "Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Number of children aged 2-12 (0-15).", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of infants under 2 (0-5).", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of pets (0-5).", "default": 0 }, "minPrice": { "title": "Minimum nightly price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Lowest nightly price to include, in the selected currency. 0 means no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum nightly price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Highest nightly price to include, in the selected currency. 0 means no maximum.", "default": 0 }, "roomType": { "title": "Room type", "enum": [ "Any", "Entire home/apt", "Private room", "Shared room", "Hotel room" ], "type": "string", "description": "Restrict results to one Airbnb room type.", "default": "Any" }, "propertyType": { "title": "Property type", "enum": [ "Any", "Apartment", "House", "Villa", "Condominium", "Loft", "Guest suite", "Guesthouse", "Hotel", "Resort", "Cottage", "Cabin", "Bungalow", "Townhouse", "Tiny home", "Boat", "Barn", "Camper/RV", "Farm stay", "Castle", "Cave", "Dome", "Container", "Treehouse", "Yurt", "Serviced apartment" ], "type": "string", "description": "Restrict results to one Airbnb property type.", "default": "Any" }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms. 0 means no minimum.", "default": 0 }, "minBeds": { "title": "Minimum beds", "minimum": 0, "maximum": 30, "type": "integer", "description": "Minimum number of beds. 0 means no minimum.", "default": 0 }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bathrooms. 0 means no minimum.", "default": 0 }, "maxListings": { "title": "Maximum listings", "minimum": 1, "maximum": 300, "type": "integer", "description": "Hard cap on records (1-300). Airbnb pages hold 40 results each; duplicate cards are removed automatically.", "default": 20 }, "includeDetails": { "title": "Include full listing details", "type": "boolean", "description": "Adds the listing page and an exact stay quote: host, amenities, photos, description, fees and availability. Costs extra requests per listing.", "default": false }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Fetch recent guest reviews for each listing (up to maxReviews).", "default": false }, "maxReviews": { "title": "Maximum reviews per listing", "minimum": 1, "maximum": 24, "type": "integer", "description": "Reviews returned per listing (1-24).", "default": 12 }, "includeCalendar": { "title": "Include availability calendar", "type": "boolean", "description": "Fetch the day-by-day availability calendar for each listing.", "default": false }, "calendarMonths": { "title": "Calendar months", "minimum": 1, "maximum": 12, "type": "integer", "description": "Number of months to return, starting with the current month (1-12).", "default": 12 }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "JPY", "CAD", "AUD", "NZD", "CHF", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "RON", "BGN", "TRY", "RUB", "UAH", "ILS", "AED", "SAR", "QAR", "KWD", "BHD", "OMR", "EGP", "ZAR", "NGN", "KES", "GHS", "MAD", "INR", "PKR", "BDT", "LKR", "NPR", "CNY", "HKD", "TWD", "SGD", "MYR", "THB", "IDR", "PHP", "VND", "KRW", "MXN", "BRL", "ARS", "CLP", "COP", "PEN", "UYU", "CRC", "DOP" ], "type": "string", "description": "Currency for prices. Airbnb returns quotes in this currency.", "default": "USD" }, "locale": { "title": "Locale", "enum": [ "en", "en-US", "en-GB", "en-CA", "en-AU", "de-DE", "fr-FR", "es-ES", "es-MX", "it-IT", "pt-BR", "pt-PT", "nl-NL", "sv-SE", "da-DK", "nb-NO", "fi-FI", "pl-PL", "cs-CZ", "hu-HU", "ro-RO", "el-GR", "tr-TR", "ru-RU", "uk-UA", "he-IL", "ar", "hi-IN", "id-ID", "th-TH", "vi-VN", "ja-JP", "ko-KR", "zh-CN", "zh-TW" ], "type": "string", "description": "Language/region used for Airbnb labels, dates and localized text.", "default": "en" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Leave empty and the actor connects directly, then switches to an automatic Apify proxy only if Airbnb blocks a request." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }