{ "openapi": "3.0.1", "info": { "title": "Airbnb Images Scraper By Location", "description": "Scrape Airbnb listings with the Airbnb LD Scraper. Extract property titles, descriptions, prices, host info, ratings, reviews, and amenities. Ideal for market research, competitor analysis, and rental trend tracking. Fast, accurate, and scalable for single or bulk listings.", "version": "0.1", "x-build-id": "teBk01dBW73SgBwAK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~airbnb-images-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-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/scrapier~airbnb-images-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-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/scrapier~airbnb-images-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-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": { "locationQuery": { "title": "📍 Location or search query", "type": "string", "description": "A city, neighborhood, or free-text search query to discover Airbnb listings in, e.g. 'Miami Beach' or 'Austin Texas'. The actor builds an Airbnb search URL from this and harvests matching listing URLs automatically. Leave empty if you provide 'searchUrl' or 'urls' instead." }, "searchUrl": { "title": "🔎 Airbnb search URL (optional)", "type": "string", "description": "An exact Airbnb search-results URL to use for discovery instead of building one from 'locationQuery', e.g. https://www.airbnb.com/s/Miami-Beach--FL/homes. Must start with https://www.airbnb.com/s/. Takes precedence over 'locationQuery' when both are set." }, "maxListings": { "title": "🔢 Max listings to discover", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of listings to discover from the location/search URL and scrape. Example: maxListings=20 → up to 20 listings are found and processed from the search results page. Default: 20.", "default": 20 }, "maxImagesPerListing": { "title": "🖼️ Max images per listing", "minimum": 1, "maximum": 300, "type": "integer", "description": "Maximum number of image URLs to keep per listing (applies to discovered listings and direct 'urls' alike). Example: maxImagesPerListing=10 keeps only the first 10 image URLs found for each listing. Default: 50 (in practice this rarely truncates, since each listing page normally exposes fewer images than this through structured page data).", "default": 50 }, "urls": { "title": "🔗 Airbnb room URLs (optional, direct)", "type": "array", "description": "Optional — one or more specific room URLs to scrape directly, in addition to anything discovered via 'locationQuery'/'searchUrl'. Each must be a valid Airbnb room page, e.g. https://www.airbnb.com/rooms/782682596976136912. Add one URL per line.", "items": { "type": "string" } }, "requestTimeoutSecs": { "title": "⏱️ Request 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 }, "proxyConfiguration": { "title": "🛡️ Proxy configuration (optional)", "type": "object", "description": "Optional Apify Proxy settings for this run. 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 proxy (e.g. US, GB). Leave empty for no country 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 } } } } } } } } } }