{ "openapi": "3.0.1", "info": { "title": "Airbnb Listings Scraper - Prices, Ratings & Geo", "description": "Scrapes Airbnb stay listings from the search page's own embedded data: price, rating, coordinates, photos and room type. Deduplicates the listings Airbnb repeats within a page, decodes the real listing id, and reports the currency the page actually rendered.", "version": "0.1", "x-build-id": "9KDbbkDTBfnFS1uwg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~airbnb-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-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/scrapyx~airbnb-listings-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-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/scrapyx~airbnb-listings-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-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": [ "places" ], "properties": { "places": { "title": "Destinations", "type": "array", "description": "Where to search, as Airbnb writes it: 'Paris, France', 'Austin, TX', 'Bali, Indonesia'.", "items": { "type": "string" } }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter code, always sent explicitly. This matters more than it looks: left off, Airbnb picks a currency from the EXIT IP — a local run returned Rupiah while the same search with currency=USD returned dollars. Airbnb does not refuse an unknown code either, it silently keeps the previous one, so this actor validates it and reports the currency the page actually rendered.", "default": "USD" }, "checkin": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD. Must be given with check-out. WITHOUT dates Airbnb prices a window of its own choosing and the headline price is a multi-night total for that window, not a nightly rate." }, "checkout": { "title": "Check-out date", "type": "string", "description": "YYYY-MM-DD. Must be given with check-in." }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Guest count passed to the search." }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Child count passed to the search." }, "priceMin": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Airbnb's own price filter, in the currency above." }, "priceMax": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Airbnb's own price filter, in the currency above." }, "roomTypes": { "title": "Room types", "type": "array", "description": "Any of: Entire home/apt, Private room, Shared room, Hotel room. Validated here — an unrecognised value would simply be ignored upstream.", "items": { "type": "string" } }, "maxListingsPerPlace": { "title": "Max listings per destination", "minimum": 0, "type": "integer", "description": "Set 0 to walk until Airbnb stops returning new listings. 18 distinct listings per cursor step.", "default": 60 }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 4, "type": "integer", "description": "Kept at 1 by default: each search page is about 930 KB of HTML and DataDome runs on this origin.", "default": 1 }, "minRequestInterval": { "title": "Min seconds between request starts", "minimum": 0, "maximum": 30, "type": "integer", "description": "Politeness pacing shared across all workers.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional, but note it changes the DATA here and not just the routing: Airbnb picks a currency from the exit address, and DataDome challenges datacenter exits far more readily than residential ones. Residential is recommended for large runs.", "default": { "useApifyProxy": 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 } } } } } } } } } }