{ "openapi": "3.0.1", "info": { "title": "Airbnb Search Scraper", "description": "Search public Airbnb stays or extract specific public room pages with bounded browsing and validated output.", "version": "1.1", "x-build-id": "eiwPFHPFNzHfHbzaR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codingfrontend~airbnb-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codingfrontend-airbnb-search-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/codingfrontend~airbnb-search-scraper/runs": { "post": { "operationId": "runs-sync-codingfrontend-airbnb-search-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/codingfrontend~airbnb-search-scraper/run-sync": { "post": { "operationId": "run-sync-codingfrontend-airbnb-search-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": { "mode": { "title": "Source mode", "enum": [ "search", "productUrl" ], "type": "string", "description": "Choose one source: search a location or open a list of public room URLs.", "default": "search" }, "location": { "title": "Location", "maxLength": 200, "type": "string", "description": "Required when mode is search. This form prefill is an example only; API callers must provide a location. Ignored in productUrl mode." }, "checkIn": { "title": "Check-in date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 10, "type": "string", "description": "Optional YYYY-MM-DD search date. Provide it together with checkOut; both dates must be today or later." }, "checkOut": { "title": "Check-out date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "maxLength": 10, "type": "string", "description": "Optional YYYY-MM-DD search date. Provide it together with checkIn and choose a later date." }, "guests": { "title": "Guests", "minimum": 1, "maximum": 16, "type": "integer", "description": "Guest count used for a location search; from 1 to 16. In productUrl mode, guest settings come from each URL.", "default": 2 }, "priceMin": { "title": "Minimum nightly price", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Optional lower price filter for search mode, in the currency shown for the Airbnb location." }, "priceMax": { "title": "Maximum nightly price", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Optional upper price filter for search mode, in the currency shown for the Airbnb location. It cannot be lower than priceMin." }, "propertyType": { "title": "Property type", "enum": [ "any", "entire_home", "private_room", "shared_room" ], "type": "string", "description": "Optional room-type filter for search mode.", "default": "any" }, "productUrls": { "title": "Listing URLs", "maxItems": 100, "type": "array", "description": "Public HTTPS Airbnb room URLs. Required in productUrl mode and must be empty in search mode. Only approved Airbnb room hosts are accepted; query parameters outside supported stay settings are removed.", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https://" }, "default": [] }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of unique, validated listing records to save across the run.", "default": 10 }, "maxPages": { "title": "Maximum search pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum search-result pages to inspect in search mode. Ignored in productUrl mode.", "default": 3 }, "deepScrape": { "title": "Visit room pages from search results", "type": "boolean", "description": "In search mode, visit each selected result's room page to add available listing details. Direct productUrl mode always reads room pages.", "default": false }, "includeReviews": { "title": "Include public reviews", "type": "boolean", "description": "Include up to ten public reviews and available review metadata when reading a room page. In search mode this applies when deepScrape is enabled.", "default": true }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 3, "type": "integer", "description": "Maximum room or search pages processed at once. Keep this low to limit load on Airbnb.", "default": 1 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 2, "type": "integer", "description": "Retry limit for a failed page request, from 0 to 2. Access denials are still treated as failures.", "default": 0 }, "requestDelayMs": { "title": "Delay between page navigations", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Minimum spacing between page navigations in milliseconds. Set to 0 only when appropriate for your permitted use.", "default": 1000 }, "navigationTimeoutSecs": { "title": "Navigation timeout", "minimum": 15, "maximum": 120, "type": "integer", "description": "Maximum seconds to wait for a page navigation, from 15 to 120.", "default": 60 }, "requestHandlerTimeoutSecs": { "title": "Request handler timeout", "minimum": 30, "maximum": 300, "type": "integer", "description": "Maximum seconds for processing one page, including extraction, from 30 to 300.", "default": 120 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy editor settings using useApifyProxy, apifyProxyGroups, or proxyUrls. Proxy use is explicit and disabled by default. If a requested proxy route is unavailable, the run fails instead of switching to direct access. Do not use proxies to bypass access controls.", "properties": { "useApifyProxy": { "title": "Use Apify Proxy", "description": "Explicitly select an Apify proxy route.", "type": "boolean" }, "apifyProxyGroups": { "title": "Apify proxy groups", "description": "Optional selected Apify proxy groups.", "type": "array" }, "apifyProxyCountry": { "title": "Apify proxy country", "description": "Optional uppercase two-letter country code for the selected Apify route.", "type": "string", "pattern": "^[A-Z]{2}$", "maxLength": 2 }, "proxyUrls": { "title": "Custom proxy URLs", "description": "Optional custom proxy route URLs; use with useApifyProxy set to false.", "type": "array" } }, "additionalProperties": 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 } } } } } } } } } }