{ "openapi": "3.0.1", "info": { "title": "Airbnb Property Details Scraper", "description": "Fast and reliable Airbnb scraper to extract full property details, pricing, availability, and calendar data.", "version": "0.1", "x-build-id": "JW6N4LBMwNRIqIVmo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlio~airbnb-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlio-airbnb-property-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/crawlio~airbnb-property-scraper/runs": { "post": { "operationId": "runs-sync-crawlio-airbnb-property-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/crawlio~airbnb-property-scraper/run-sync": { "post": { "operationId": "run-sync-crawlio-airbnb-property-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": { "operation": { "title": "Operation", "enum": [ "property", "property_summary", "pricing", "availability", "calendar" ], "type": "string", "description": "Choose the level of property detail you want.", "default": "property" }, "property": { "title": "Property input", "type": "object", "description": "Configure settings for property input.", "properties": { "url": { "title": "Listing URL", "type": "string", "description": "Single Airbnb listing URL.", "editor": "textfield", "prefill": "https://www.airbnb.com/rooms/1521077635925541411", "default": "https://www.airbnb.com/rooms/1521077635925541411" }, "urls": { "title": "Listing URLs", "type": "array", "description": "Optional batch list of Airbnb listing URLs.", "editor": "stringList", "items": { "type": "string" } }, "adults": { "title": "Adults", "type": "integer", "default": 2, "minimum": 1, "maximum": 16, "editor": "number", "description": "Number of adults for the stay. Used to calculate accurate pricing." }, "nights": { "title": "Auto-select nights", "type": "integer", "default": 2, "minimum": 1, "maximum": 30, "editor": "number", "description": "Number of nights to check for pricing/availability if specific dates are not provided." } }, "additionalProperties": false }, "property_summary": { "title": "Property summary input", "type": "object", "description": "Configure settings for property summary input.", "properties": { "url": { "title": "Listing URL", "type": "string", "description": "Single Airbnb listing URL.", "editor": "textfield", "prefill": "https://www.airbnb.com/rooms/1521077635925541411", "default": "https://www.airbnb.com/rooms/1521077635925541411" }, "urls": { "title": "Listing URLs", "type": "array", "description": "Optional batch list of Airbnb listing URLs.", "editor": "stringList", "items": { "type": "string" } }, "adults": { "title": "Adults", "type": "integer", "default": 2, "minimum": 1, "maximum": 16, "editor": "number", "description": "Number of adults for the stay. Used to calculate accurate pricing." }, "nights": { "title": "Auto-select nights", "type": "integer", "default": 2, "minimum": 1, "maximum": 30, "editor": "number", "description": "Number of nights to check for pricing/availability if specific dates are not provided." } }, "additionalProperties": false }, "pricing": { "title": "Pricing input", "type": "object", "description": "Configure settings for pricing input.", "properties": { "url": { "title": "Listing URL", "type": "string", "description": "Single Airbnb listing URL.", "editor": "textfield", "prefill": "https://www.airbnb.com/rooms/1521077635925541411", "default": "https://www.airbnb.com/rooms/1521077635925541411" }, "urls": { "title": "Listing URLs", "type": "array", "description": "Optional batch list of Airbnb listing URLs.", "editor": "stringList", "items": { "type": "string" } }, "checkin": { "title": "Check-in", "type": "string", "description": "Optional explicit check-in date in YYYY-MM-DD format.", "editor": "datepicker", "dateType": "absolute" }, "checkout": { "title": "Check-out", "type": "string", "description": "Optional explicit check-out date in YYYY-MM-DD format.", "editor": "datepicker", "dateType": "absolute" }, "adults": { "title": "Adults", "type": "integer", "default": 2, "minimum": 1, "maximum": 16, "editor": "number", "description": "Number of adults for the stay. Used to calculate accurate pricing." }, "nights": { "title": "Auto-select nights", "type": "integer", "default": 2, "minimum": 1, "maximum": 30, "editor": "number", "description": "Number of nights to check for pricing/availability if specific dates are not provided." } }, "additionalProperties": false }, "availability": { "title": "Availability input", "type": "object", "description": "Configure settings for availability input.", "properties": { "url": { "title": "Listing URL", "type": "string", "description": "Single Airbnb listing URL.", "editor": "textfield", "prefill": "https://www.airbnb.com/rooms/1521077635925541411", "default": "https://www.airbnb.com/rooms/1521077635925541411" }, "urls": { "title": "Listing URLs", "type": "array", "description": "Optional batch list of Airbnb listing URLs.", "editor": "stringList", "items": { "type": "string" } }, "checkin": { "title": "Check-in", "type": "string", "description": "Optional explicit check-in date in YYYY-MM-DD format.", "editor": "datepicker", "dateType": "absolute" }, "checkout": { "title": "Check-out", "type": "string", "description": "Optional explicit check-out date in YYYY-MM-DD format.", "editor": "datepicker", "dateType": "absolute" }, "adults": { "title": "Adults", "type": "integer", "default": 2, "minimum": 1, "maximum": 16, "editor": "number", "description": "Number of adults for the stay. Used to calculate accurate pricing." }, "nights": { "title": "Auto-select nights", "type": "integer", "default": 2, "minimum": 1, "maximum": 30, "editor": "number", "description": "Number of nights to check for pricing/availability if specific dates are not provided." } }, "additionalProperties": false }, "calendar": { "title": "Calendar input", "type": "object", "description": "Configure settings for calendar input.", "properties": { "url": { "title": "Listing URL", "type": "string", "description": "Single Airbnb listing URL to extract calendar data from.", "editor": "textfield", "prefill": "https://www.airbnb.com/rooms/1521077635925541411", "default": "https://www.airbnb.com/rooms/1521077635925541411" }, "month": { "title": "Calendar start month", "type": "integer", "minimum": 1, "maximum": 12, "editor": "number", "description": "Starting month for the calendar (1-12). If empty, defaults to the current month." }, "year": { "title": "Calendar start year", "type": "integer", "minimum": 2024, "maximum": 2035, "editor": "number", "description": "Starting year for the calendar (e.g. 2026). If empty, defaults to the current year." }, "count": { "title": "Calendar month count", "type": "integer", "default": 3, "minimum": 1, "maximum": 12, "editor": "number", "description": "Number of consecutive months of calendar data to extract." } }, "additionalProperties": false }, "proxyConfiguration": { "title": "Proxy Settings", "type": "object", "description": "Select proxies to be used.", "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 } } } } } } } } } }