{ "openapi": "3.0.1", "info": { "title": "Airbnb Search Scraper Pro", "description": "Airbnb listings for any city or search URL: stay total, nightly rate, discounts, rating, reviews, Guest favorite, beds, baths, coordinates and photos. Rating, review and price filters run before billing. $0.03 per 1,000.", "version": "0.0", "x-build-id": "grottuhOPmVJK2q6b" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/red.cars~airbnb-search-scraper-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-red.cars-airbnb-search-scraper-pro", "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/red.cars~airbnb-search-scraper-pro/runs": { "post": { "operationId": "runs-sync-red.cars-airbnb-search-scraper-pro", "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/red.cars~airbnb-search-scraper-pro/run-sync": { "post": { "operationId": "run-sync-red.cars-airbnb-search-scraper-pro", "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": { "locationQueries": { "title": "Locations", "type": "array", "description": "Cities, neighborhoods or regions as you would type them on Airbnb, e.g. \"Miami, FL\" or \"Lisbon, Portugal\".", "items": { "type": "string" } }, "searchUrls": { "title": "Airbnb search URLs (optional)", "type": "array", "description": "Paste airbnb.com/s/... search URLs with your own map area and filters. Used in addition to Locations.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max listings (total)", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on listings saved across all searches. Airbnb shows up to about 270 per search, so split big cities by neighborhood.", "default": 10 }, "checkIn": { "title": "Check-in date", "type": "string", "description": "YYYY-MM-DD. With dates you get the real total for the stay and the nightly rate." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "YYYY-MM-DD." }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Number of adult guests.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Number of children.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "type": "integer", "description": "Number of pets. Above 0 returns pet-friendly stays only.", "default": 0 }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter currency code for prices, e.g. USD, EUR, GBP.", "default": "USD" }, "priceMin": { "title": "Airbnb min price", "minimum": 0, "type": "integer", "description": "Passed to Airbnb's own price filter." }, "priceMax": { "title": "Airbnb max price", "minimum": 0, "type": "integer", "description": "Passed to Airbnb's own price filter." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Passed to Airbnb's own filter." }, "minBeds": { "title": "Min beds", "minimum": 0, "type": "integer", "description": "Passed to Airbnb's own filter." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Passed to Airbnb's own filter." }, "entireHomeOnly": { "title": "Entire homes only", "type": "boolean", "description": "Skip private and shared rooms.", "default": false }, "minRating": { "title": "Min rating (free filter)", "type": "string", "description": "e.g. 4.8. Listings below it are dropped before saving and never billed." }, "minReviews": { "title": "Min reviews (free filter)", "minimum": 0, "type": "integer", "description": "Drop listings with fewer reviews, before billing." }, "maxNightlyPrice": { "title": "Max nightly price (free filter)", "minimum": 0, "type": "integer", "description": "Drop listings whose nightly rate is higher, before billing." }, "guestFavoriteOnly": { "title": "Guest favorites only (free filter)", "type": "boolean", "description": "Keep only listings with Airbnb's Guest favorite badge.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for most runs. The actor switches to residential proxy on its own if Airbnb blocks a page.", "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 }, "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 } } } } } } } } } }