{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper — Stays, Reviews & Availability", "description": "Three focused modes for Airbnb stay research: search cards, full search and listing URLs. Collect available prices, public host details, reviews, calendars, contacts and labelled revenue estimates. Platform usage included.", "version": "1.0", "x-build-id": "aeNLziB59lDegha9M" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shadowextractor~airbnb-stays-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shadowextractor-airbnb-stays-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/shadowextractor~airbnb-stays-scraper/runs": { "post": { "operationId": "runs-sync-shadowextractor-airbnb-stays-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/shadowextractor~airbnb-stays-scraper/run-sync": { "post": { "operationId": "run-sync-shadowextractor-airbnb-stays-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": "What would you like to collect?", "enum": [ "search-fast", "search-full", "urls" ], "type": "string", "description": "Fast searches locations for listing cards. Full searches locations and adds available property/host details plus selected extras. Listing URLs collects details for your own Airbnb URLs.", "default": "search-fast" }, "queries": { "title": "Locations or Airbnb listing URLs", "minItems": 1, "maxItems": 1000, "type": "array", "description": "One target per entry: a city/neighborhood for search modes, or an airbnb.com/rooms/... URL in Listing URLs. Use locations or listing URLs in a run, not a mixture.", "items": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "maxItemsPerQuery": { "title": "Listing limit", "minimum": 1, "maximum": 270, "type": "integer", "description": "Successfully saved unique listings per location search. In Listing URLs mode this caps the whole URL run. Missing, failed or duplicate listings do not use the saved-listing allowance.", "default": 10 }, "checkIn": { "title": "Check-in", "type": "string", "description": "Add a future date when you need date-aware prices and availability." }, "checkOut": { "title": "Check-out", "type": "string", "description": "Must be later than check-in." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests.", "default": 2 }, "currency": { "title": "Currency", "enum": [ "USD", "EUR" ], "type": "string", "description": "Currency used for price fields.", "default": "USD" }, "minPrice": { "title": "Minimum search price", "minimum": 0, "type": "integer", "description": "Native Airbnb lower price filter for location searches, in the selected currency and travel context. It is not a promise that every displayed price excludes or includes all fees." }, "maxPrice": { "title": "Maximum search price", "minimum": 0, "type": "integer", "description": "Maximum price filter in the selected currency." }, "roomType": { "title": "Room type", "enum": [ "", "Entire home/apt", "Private room", "Shared room", "Hotel room" ], "type": "string", "description": "Filter listings by stay type.", "default": "" }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Keep listings with at least this many bedrooms." }, "includeReviews": { "title": "Collect review text", "type": "boolean", "description": "Save guest review text, star ratings and Review summary analytics. Available in Full search and Listing URLs.", "default": false }, "maxReviewsPerListing": { "title": "Reviews per listing", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum guest reviews to save per listing when reviews are enabled. Use 1 or 10 for quick tests, 50 for deeper analysis.", "default": 50 }, "includeCalendar": { "title": "Include availability calendar", "type": "boolean", "description": "Save up to 12 months of availability when Airbnb returns them. Available in Full search and Listing URLs.", "default": false }, "includeContacts": { "title": "Find published business contacts", "type": "boolean", "description": "Check public listing text and identity-matched official business websites in Full search or Listing URLs. Includes source links when contacts are found. Private booking-only contacts are not exposed. Included in the detailed-listing price.", "default": false }, "analyzeRevenue": { "title": "Calculate labelled revenue estimates", "type": "boolean", "description": "Use the available calendar and published prices for projections. This also requests the calendar. Unavailable nights may be booked or host-blocked; estimates are not confirmed income. No additional event fee.", "default": false }, "proxy": { "title": "Connection settings", "type": "object", "description": "Default connection settings work for most runs. Advanced users can customize them here.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }