{ "openapi": "3.0.1", "info": { "title": "Airbnb Images Scraper With Captions & Room Tags", "description": "Airbnb Images Scraper with Captions & Room Tags extracts listing images, captions, room labels, property details, and image URLs. Analyze property visuals, identify room types, compare listings, and collect structured Airbnb image data for research and market analysis.", "version": "0.1", "x-build-id": "YzFElfHdvsewiFJfJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapio~airbnb-images-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapio-airbnb-images-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/scrapio~airbnb-images-scraper/runs": { "post": { "operationId": "runs-sync-scrapio-airbnb-images-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/scrapio~airbnb-images-scraper/run-sync": { "post": { "operationId": "run-sync-scrapio-airbnb-images-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": { "galleryUrls": { "title": "🖼️ Airbnb listing URLs", "type": "array", "description": "One or more room URLs to scrape. Each must be a valid Airbnb room page, e.g. https://www.airbnb.com/rooms/782682596976136912. Add one URL per line. At least one URL is required (here, or in the legacy 'urls' field below).", "items": { "type": "string" } }, "locale": { "title": "🌐 Caption language / locale", "type": "string", "description": "Locale code Airbnb uses to localize photo captions and listing text when available, e.g. 'en', 'fr', 'de', 'es', 'pt', 'it', 'ja'. Default: 'en'. If Airbnb has no translation for a photo caption, the original text is returned (never fabricated).", "default": "en" }, "fetchTimeoutSecs": { "title": "⏱️ Fetch timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time in seconds to wait for each HTTP response before the request is skipped. Default: 30. Allowed range: 5–120.", "default": 30 }, "groupByRoom": { "title": "🗂️ Group photos by room/space", "type": "boolean", "description": "When enabled, adds a 'photosByRoom' object to each row that buckets the same photos by their derived room/space tag (e.g. all 'Bedroom' photos together, all 'Kitchen' photos together). The flat 'photos' array is always returned regardless of this setting. Default: false.", "default": false }, "includeOrientation": { "title": "📐 Include photo orientation", "type": "boolean", "description": "When enabled, each photo in the 'photos' array includes an 'orientation' field (e.g. LANDSCAPE, PORTRAIT, SQUARE) as reported by Airbnb, or null when Airbnb does not report one. Default: true.", "default": true }, "urls": { "title": "🔗 Legacy: room URLs", "type": "array", "description": "Legacy alias for 'galleryUrls' from the original actor's input. If both are set, entries from both are merged and de-duplicated.", "items": { "type": "string" } }, "requestTimeoutSecs": { "title": "⏱️ Legacy: request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Legacy alias for 'fetchTimeoutSecs'. Used only when 'fetchTimeoutSecs' is not set." }, "proxyConfiguration": { "title": "🛡️ Proxy configuration", "type": "object", "description": "You can choose proxy groups and optionally a country code.", "properties": { "useApifyProxy": { "title": "✅ Use Apify Proxy", "type": "boolean", "description": "Enable Apify Proxy for this run." }, "apifyProxyGroups": { "title": "📌 Proxy groups", "type": "array", "items": { "type": "string" }, "description": "Apify proxy groups to use for this run." }, "apifyProxyCountry": { "title": "🌍 Proxy country", "type": "string", "description": "Optional ISO-2 country code for the proxy (e.g. US, GB). Leave empty for no restriction." } } } } }, "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 } } } } } } } } } }