{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper: Listings, Prices & Availability by Location", "description": "Search Airbnb by city or pasted search URL and export listings with prices, ratings, rooms and coordinates. Add dates for exact stay prices and availability, or pass listing URLs for full details: host, amenities, rules. Public logged-out data, no login.", "version": "0.1", "x-build-id": "Le5GuSAhAMJw9RA6U" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/changefeeds~airbnb-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-changefeeds-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/changefeeds~airbnb-listings-scraper/runs": { "post": { "operationId": "runs-sync-changefeeds-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/changefeeds~airbnb-listings-scraper/run-sync": { "post": { "operationId": "run-sync-changefeeds-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", "properties": { "locations": { "title": "Locations or search URLs", "type": "array", "description": "Places to search, one per line: a city, region or neighbourhood (\"Lisbon, Portugal\"), or a full airbnb.com/s/... search URL copied from your browser, which is used as-is with all its filters (room type, amenities, map area). Each entry returns up to `maxItems` listings.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs or ids", "type": "array", "description": "Specific listings, one per line: airbnb.com/rooms/ URLs (any Airbnb country domain) or bare numeric ids. Each returns one row with full details. With check-in/check-out dates, the row also has the price and availability for those dates.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD. Optional; give it together with check-out. Without dates, Airbnb prices each search result for sample dates it picks itself (reported in price.checkIn / price.checkOut), and listing URLs come back without a price." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "YYYY-MM-DD, after check-in." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests, 1 to 16. Affects which listings are shown and their prices.", "default": 2 }, "currency": { "title": "Currency", "type": "string", "description": "3-letter currency code for prices, e.g. USD, EUR, GBP, JPY. A pasted search URL that already has a currency keeps its own.", "default": "USD" }, "minPrice": { "title": "Minimum price per night", "minimum": 0, "type": "integer", "description": "Optional. Airbnb's own price filter, per night, in the chosen currency. Searches only. Splitting one search into price bands is the way to get past Airbnb's 15-page limit (see README)." }, "maxPrice": { "title": "Maximum price per night", "minimum": 1, "type": "integer", "description": "Optional. Airbnb's own price filter, per night, in the chosen currency. Searches only." }, "maxItems": { "title": "Max listings per location", "minimum": 1, "maximum": 270, "type": "integer", "description": "Max listings returned per location, 1 to 270. Airbnb itself shows at most 15 pages of 18 results per search, and pages overlap, so a single search usually tops out around 240 unique listings.", "default": 100 }, "includeDetails": { "title": "Include listing details for search results", "type": "boolean", "description": "Also open each search result's listing page and add the description, amenities, house rules, host, room type and sub-ratings. One extra page per listing, so slower, and charged as details-added per listing (see Pricing).", "default": false }, "proxy": { "title": "Proxy", "type": "object", "description": "Airbnb blocks many datacenter IPs, so requests go through Apify Proxy by default (residential). Proxy traffic is included in the price. Turn it off only if you run the Actor from your own network.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }