{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper", "description": "🏑 Search Airbnb listings with powerful filters, automatic pagination, and structured export-ready results", "version": "0.0", "x-build-id": "W0ATgYMSo33s7D9Ed" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-ninja~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-ninja-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/api-ninja~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-api-ninja-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/api-ninja~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-api-ninja-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": [ "searchDestinations" ], "properties": { "searchDestinations": { "title": "πŸ“ Destination", "type": "string", "description": "Destination to search, for example `toronto, canada`." }, "homesPerSearch": { "title": "πŸ”’ Max Listings", "minimum": 40, "type": "integer", "description": "Maximum number of listings to save. Ignored when `Scrape all available listings` is enabled.", "default": 120 }, "scrapeAll": { "title": "♾️ Scrape All Available Listings", "type": "boolean", "description": "Keep paginating until the API stops returning `nextPageCursor`.", "default": false }, "resultsType": { "title": "πŸ—‚οΈ Result Type", "enum": [ "search_results", "map_results", "map-plus_search_results" ], "type": "string", "description": "Choose which result group the API should return." }, "checkIn": { "title": "πŸ—“οΈ Check-In", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Exact check-in date in `YYYY-MM-DD` format. When used together with check-out, flexible date inputs are ignored." }, "checkOut": { "title": "🧳 Check-Out", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$", "type": "string", "description": "Exact check-out date in `YYYY-MM-DD` format." }, "flexibleDateFilters": { "title": "πŸ“† Flexible Date Window", "enum": [ "Exact_dates", "plusminus_1day", "plusminus_2days", "plusminus_3days", "plusminus_7days", "plusminus_14days" ], "type": "string", "description": "How flexible the dates can be when exact dates are not used.", "default": "Exact_dates" }, "months": { "title": "πŸ—“οΈ Stay Months", "enum": [ "None", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12" ], "type": "string", "description": "Number of months for a flexible stay search. The API also accepts `None`.", "default": "None" }, "flexibleStayPeriod": { "title": "πŸ›Œ Flexible Stay Period", "enum": [ "Weekend", "Week", "Month" ], "type": "string", "description": "Preferred flexible stay length.", "default": "Weekend" }, "goAnytimeMonths": { "title": "🌀️ Go Anytime Months", "type": "string", "description": "Comma-separated lowercase month names, for example `january,february,march`." }, "imFlexibleOfDestination": { "title": "🧭 Flexible Destination", "type": "boolean", "description": "Search broader destination ideas instead of a strict destination match.", "default": false }, "adults": { "title": "πŸ§‘ Adults", "minimum": 0, "type": "integer", "description": "Guests aged 13 or above.", "default": 2 }, "children": { "title": "πŸ§’ Children", "minimum": 0, "type": "integer", "description": "Guests aged 2 to 12.", "default": 0 }, "infants": { "title": "πŸ‘Ά Infants", "minimum": 0, "type": "integer", "description": "Guests aged 0 to 2.", "default": 0 }, "pets": { "title": "🐾 Pets", "minimum": 0, "type": "integer", "description": "Number of pets.", "default": 0 }, "typeOfPlace": { "title": "🏑 Place Type", "enum": [ "Any_type", "Room", "Entire_home" ], "type": "string", "description": "Listing type filter." }, "currency": { "title": "πŸ’΅ Currency", "type": "string", "description": "Currency code, for example `USD`, `EUR`, or `GBP`.", "default": "USD" }, "priceRangeMin": { "title": "πŸ’² Min Price", "minimum": 0, "type": "integer", "description": "Minimum price filter.", "default": 20 }, "priceRangeMax": { "title": "πŸ’° Max Price", "minimum": 0, "type": "integer", "description": "Maximum price filter.", "default": 5000 }, "bedrooms": { "title": "πŸ›οΈ Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum bedroom count." }, "beds": { "title": "πŸ›Œ Beds", "minimum": 0, "type": "integer", "description": "Minimum bed count." }, "bathrooms": { "title": "πŸ› Bathrooms", "minimum": 0, "type": "integer", "description": "Minimum bathroom count." }, "amenities": { "title": "✨ Amenities", "type": "string", "description": "Comma-separated amenity IDs, for example `4,8,33`." }, "bookingOptions": { "title": "βœ… Booking Options", "type": "string", "description": "Comma-separated values such as `instant book,self checkin,allow pets,free cancellation`." }, "guestFavorite": { "title": "⭐ Guest Favorite Only", "type": "boolean", "description": "Only include listings marked as Guest favorite.", "default": false }, "luxuryHomes": { "title": "πŸ’Ž Luxury Homes Only", "type": "boolean", "description": "Only include luxury home listings.", "default": false }, "superhost": { "title": "🦸 Superhost Only", "type": "boolean", "description": "Only include Superhost listings.", "default": false }, "propertyType": { "title": "🏘️ Property Type", "type": "string", "description": "Comma-separated values such as `House,Flat,Guest house,Hotel`." }, "accessibilityFeatures": { "title": "β™Ώ Accessibility Features", "type": "string", "description": "Comma-separated accessibility IDs, for example `110,111,291`." }, "hostLanguages": { "title": "πŸ—£οΈ Host Languages", "type": "string", "description": "Comma-separated host language codes, for example `zh,de`." } } }, "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 } } } } } } } } } }