{ "openapi": "3.0.1", "info": { "title": "AirBnb Listings Scraper", "description": "Airbnb Listings Scraper extracts Airbnb listing data by location, dates, guests, price, and room type. It collects IDs, URLs, titles, prices, ratings, images, coordinates, host details, amenities, and capacity for travel analytics, market research, and monitoring workflows.", "version": "0.0", "x-build-id": "7WyQIsQCppZNeJjq5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sovanza.inc~airbnb-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sovanza.inc-airbnb-listings-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/sovanza.inc~airbnb-listings-scraper/runs": { "post": { "operationId": "runs-sync-sovanza.inc-airbnb-listings-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/sovanza.inc~airbnb-listings-scraper/run-sync": { "post": { "operationId": "run-sync-sovanza.inc-airbnb-listings-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": { "locationQueries": { "title": "Location queries", "type": "array", "description": "List of locations to search (e.g. \"New York, NY\", \"London, UK\").", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Check-in date (YYYY-MM-DD).", "default": "" }, "checkOut": { "title": "Check-out date", "type": "string", "description": "Check-out date (YYYY-MM-DD).", "default": "" }, "adults": { "title": "Adults", "minimum": 0, "maximum": 16, "type": "integer", "description": "Number of adults.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "maximum": 15, "type": "integer", "description": "Number of children.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of infants.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of pets. Only properties that allow pets will be shown.", "default": 0 }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum price per night (in currency units)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum price per night (in currency units)." }, "roomTypes": { "title": "Room types", "type": "array", "description": "Filter by room type: Entire home/apt, Private room, Hotel room, Shared room.", "items": { "type": "string" } }, "currency": { "title": "Currency", "type": "string", "description": "Currency code for prices (e.g. USD, EUR).", "default": "USD" }, "locale": { "title": "Locale", "type": "string", "description": "Locale for the site (e.g. en-US).", "default": "en-US" }, "limit": { "title": "Max total listings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum total number of listings to scrape across all location queries. The scraper distributes this cap across locations, stopping as soon as the total is reached.", "default": 200 }, "includeDetails": { "title": "Include detail data", "type": "boolean", "description": "If true, the scraper opens each listing detail page (/rooms/{id}) to enrich fields like description, host, coordinates, amenities, images, and reviews. Enabled by default for complete data. Disable to scrape faster with basic data only.", "default": true }, "maxDetailPages": { "title": "Max detail pages", "minimum": 0, "maximum": 500, "type": "integer", "description": "Maximum number of listing detail pages to visit per location when 'Include detail data' is enabled. Set to 0 (default) to enrich all collected listings. Useful for limiting run time.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy settings. Use residential proxy for best results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }