{ "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": "oFXzwBDaRh8bcsCvc" }, "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": [ "query" ], "properties": { "query": { "title": "πŸ“ Location query", "type": "string", "description": "Enter the city, region, or destination to search. Include the state and country for more accurate results, for example: New York City, New York, United States." }, "homesPerSearch": { "title": "🎯 Max listings", "minimum": 1, "type": "integer", "description": "Maximum number of listings to save across all pages. Ignored when Scrape all available listings is enabled.", "default": 120 }, "scrapeAll": { "title": "πŸ“š Scrape all available listings", "type": "boolean", "description": "Collect all available search pages automatically, up to page 50. Ignores Max listings. Search results may cover only part of the listings in a destination.", "default": false }, "checkin": { "title": "πŸ“… Check-in", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Arrival date in YYYY-MM-DD format, today or later. Enter Check-out too. Leave both dates blank to see prices for automatically selected upcoming stays." }, "checkout": { "title": "πŸ“… Check-out", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Departure date in YYYY-MM-DD format. Must be after Check-in. Enter both dates together, or leave both blank." }, "adults": { "title": "πŸ‘€ Adults", "minimum": 0, "maximum": 16, "type": "integer", "description": "Number of adults (0–16).", "default": 2 }, "children": { "title": "πŸ§’ Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Number of children (0–15).", "default": 0 }, "infants": { "title": "πŸ‘Ά Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of infants (0–5).", "default": 0 }, "pets": { "title": "🐾 Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of pets (0–5).", "default": 0 }, "price_min": { "title": "πŸ’° Minimum nightly price", "minimum": 0, "type": "integer", "description": "Minimum nightly price in the currency of your selected Airbnb country site. Leave blank for no minimum." }, "price_max": { "title": "πŸ’° Maximum nightly price", "minimum": 0, "type": "integer", "description": "Maximum nightly price in the currency of your selected Airbnb country site. Must be at least Minimum nightly price when both are set. Leave blank for no maximum." }, "domain": { "title": "🌐 Airbnb country domain", "type": "string", "description": "Choose the Airbnb country site to set the language and currency of results. Enter a domain or full URL, for example airbnb.com (US), airbnb.co.uk (UK), airbnb.ca (Canada), or airbnb.fr (France).", "default": "airbnb.com" }, "place_id": { "title": "πŸ—ΊοΈ Google place ID (optional)", "type": "string", "description": "Optional Google place ID for your destination, if you already know it. It helps distinguish locations with similar names. Otherwise, leave this blank and enter the destination in Location query." } } }, "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 } } } } } } } } } }