{ "openapi": "3.0.1", "info": { "title": "Airbnb Listings Scraper", "description": "Scrape Airbnb stays for any destination and dates - total price, discount, rating, review count, room and bed counts, coordinates and photos, in the currency you ask for.", "version": "0.1", "x-build-id": "KPa2CkqVHLqn2zGib" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/superslowsloth~airbnb-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-superslowsloth-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/superslowsloth~airbnb-listings-scraper/runs": { "post": { "operationId": "runs-sync-superslowsloth-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/superslowsloth~airbnb-listings-scraper/run-sync": { "post": { "operationId": "run-sync-superslowsloth-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", "required": [ "locations" ], "properties": { "locations": { "title": "Destinations", "type": "array", "description": "Where to search, one per line, exactly as you would type it into Airbnb: \"Kyoto, Japan\", \"Lisbon\", \"Big Sur, California\". Each destination is searched separately and the results are merged, with any stay that matches more than one delivered and charged only once.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in", "type": "string", "description": "First night, as YYYY-MM-DD. Must be given together with the check-out date: Airbnb quietly ignores a lone date and prices an undated stay instead, which would fill the price column with numbers for nobody's trip. Leave both empty to read Airbnb's undated prices." }, "checkOut": { "title": "Check-out", "type": "string", "description": "Departure day, as YYYY-MM-DD. Must be after the check-in date, and must be given together with it." }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Guest count Airbnb should price for. It changes both the prices and which listings appear at all, so it is part of the measurement.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Children aged 2-12, priced as guests by many hosts.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "type": "integer", "description": "Children under 2. They do not usually count towards the guest total but do filter out listings that refuse them.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "type": "integer", "description": "Pets travelling with you. Filters out listings that do not allow them, and some hosts charge for them.", "default": 0 }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter code Airbnb should quote in, e.g. \"USD\", \"EUR\", \"JPY\". Leave empty to take whatever Airbnb picks for the exit address the run uses - which is not stable between runs, so setting this is what makes two runs comparable.", "default": "USD" }, "minPrice": { "title": "Minimum nightly price", "minimum": 0, "type": "integer", "description": "Cheapest nightly rate to include, in the currency above. Airbnb applies this to the nightly rate, while the price on each row is the total for the stay." }, "maxPrice": { "title": "Maximum nightly price", "minimum": 0, "type": "integer", "description": "Dearest nightly rate to include, in the currency above." }, "roomTypes": { "title": "Room types", "type": "array", "description": "Restrict to certain kinds of stay, using Airbnb's own names: \"Entire home/apt\", \"Private room\", \"Shared room\", \"Hotel room\". Leave empty for every type.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum listings", "minimum": 1, "type": "integer", "description": "Budget for the whole run, across every destination, not per destination. Airbnb repeats listings between pages as it re-ranks, and those repeats are delivered and charged once.", "default": 100 }, "maxPages": { "title": "Maximum pages per destination", "minimum": 1, "type": "integer", "description": "How deep to walk one destination. A page carries about 18 stays and Airbnb offers roughly 15 pages for a search, so about 270 stays is the site's own ceiling for a single destination whatever is set here. More destinations is usually better than a deeper walk on one.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Airbnb answered a plain datacenter address on 2026-09-12 with no proxy at all. It does refuse an address that pages quickly, serving a human-verification page with HTTP 200, and a proxy is what gives the scraper a fresh address to retry on when that happens." } } }, "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 } } } } } } } } } }