{ "openapi": "3.0.1", "info": { "title": "Airbnb API: Listing Details Scraper", "description": "Collect public Airbnb listing details from room URLs or IDs: amenities, house rules, hosts, photos, ratings and optional stay prices with tax inclusion. One row per delivered listing.", "version": "0.1", "x-build-id": "ceolGtKP9t3F7UzNQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~airbnb-listing-details/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-airbnb-listing-details", "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/s-r~airbnb-listing-details/runs": { "post": { "operationId": "runs-sync-s-r-airbnb-listing-details", "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/s-r~airbnb-listing-details/run-sync": { "post": { "operationId": "run-sync-s-r-airbnb-listing-details", "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": { "start_urls": { "title": "Start urls", "type": "array", "description": "Airbnb room URLs or objects with a url field. URL query dates and guest counts are ignored. Canonical start_urls takes precedence over startUrls.", "items": { "type": "string" } }, "startUrls": { "title": "Starturls", "type": "array", "description": "Airbnb room URLs or objects with a url field. URL query dates and guest counts are ignored. Canonical start_urls takes precedence over startUrls.", "items": { "type": "string" } }, "listing_ids": { "title": "Listing ids", "type": "array", "description": "Numeric Airbnb listing IDs; use strings for large IDs to preserve every digit. Combined with the URL list and deduplicated in order.", "items": { "type": "string" } }, "check_in": { "title": "Check in", "type": "string", "description": "Optional stay date (YYYY-MM-DD). Provide check-in and check-out together; check-in must not be in the past. Snake case takes precedence over its camel case alias." }, "check_out": { "title": "Check out", "type": "string", "description": "Optional stay date (YYYY-MM-DD). Provide check-in and check-out together; check-in must not be in the past. Snake case takes precedence over its camel case alias." }, "checkIn": { "title": "Checkin", "type": "string", "description": "Optional stay date (YYYY-MM-DD). Provide check-in and check-out together; check-in must not be in the past. Snake case takes precedence over its camel case alias." }, "checkOut": { "title": "Checkout", "type": "string", "description": "Optional stay date (YYYY-MM-DD). Provide check-in and check-out together; check-in must not be in the past. Snake case takes precedence over its camel case alias." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Adult guests for the stay quote.", "default": 1 }, "children": { "title": "Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Child guests for the stay quote.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Infant guests for the stay quote.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Pets for the stay quote.", "default": 0 }, "max_photos": { "title": "Max photos", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum photo records per listing; zero omits photos.", "default": 1000 }, "max_listings": { "title": "Max listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum combined unique listing inputs to process across all cursor pages. Non-paying users are capped at ten.", "default": 10000 }, "currency": { "title": "Currency", "type": "string", "description": "Supported ISO 4217 currency for stay prices; converted to uppercase.", "default": "USD" }, "proxy_country": { "title": "Proxy country", "type": "string", "description": "ISO alpha-2 exit country for the quote. Defaults to the configured country. NL usually includes taxes, US usually excludes them; inspect price_includes_taxes." }, "cursor": { "title": "Cursor", "maxLength": 300, "type": "string", "description": "Opaque next_cursor from a previous response with exactly the same inputs. Omit for the first request." } } }, "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 } } } } } } } } } }