{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper: Listings, Prices, Availability & Reviews", "description": "Search public stays by location, dates, guests and filters. Get listing details, dated prices, amenities, host information, reviews and availability calendars. No login. Failed requests are free.", "version": "0.1", "x-build-id": "aqnLI2db2H0y1mcr4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-airbnb-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/zaiq~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-zaiq-airbnb-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/zaiq~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-zaiq-airbnb-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": { "locations": { "title": "Locations", "type": "array", "description": "City or region followed by its country. One location per entry. Mismatched places are rejected; use local spellings or a smaller area if needed.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing links or IDs", "type": "array", "description": "Public listing links or numeric listing IDs. Up to 50. Links are normalized to the public listing page.", "items": { "type": "string" } }, "checkin": { "title": "Check in", "type": "string", "description": "Arrival YYYY-MM-DD. Leave both dates blank for the site’s suggested dates on search rows; direct links then have no dated quote." }, "checkout": { "title": "Check out", "type": "string", "description": "Departure YYYY-MM-DD, after check in. Omit for check in plus nights." }, "nights": { "title": "Nights", "minimum": 1, "maximum": 90, "type": "integer", "description": "Length of stay when check out is omitted.", "default": 3 }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Adults included in the search and price request.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "maximum": 10, "type": "integer", "description": "Children included in the search and price request.", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "maximum": 5, "type": "integer", "description": "Infants included in the search and price request.", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "maximum": 5, "type": "integer", "description": "Pets included in the search and price request.", "default": 0 }, "maxListingsPerLocation": { "title": "Listings per location", "minimum": 1, "maximum": 270, "type": "integer", "description": "Maximum per location; the site exposes at most 270. Results may overlap across searches.", "default": 3 }, "reviewsPerListing": { "title": "Reviews per listing", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Maximum public reviews per listing. Zero skips reviews. Fewer may exist or be accessible.", "default": 0 }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Zero means no minimum.", "default": 0 }, "minBeds": { "title": "Minimum beds", "minimum": 0, "maximum": 30, "type": "integer", "description": "Zero means no minimum.", "default": 0 }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "type": "number", "description": "Minimum bathrooms, including half bathrooms. Zero means no minimum.", "default": 0 }, "priceMin": { "title": "Minimum nightly price", "minimum": 0, "type": "number", "description": "Lower nightly search filter in the selected currency. Zero means no minimum.", "default": 0 }, "priceMax": { "title": "Maximum nightly price", "minimum": 0, "type": "number", "description": "Upper nightly search filter in the selected currency. Zero means no maximum.", "default": 0 }, "roomType": { "title": "Room type", "enum": [ "any", "entire", "private", "shared", "hotel" ], "type": "string", "description": "Type of accommodation to search for.", "default": "any" }, "details": { "title": "Listing details", "type": "boolean", "description": "Get full listing information and a price request for supplied dates. Charged once as a detailed listing instead of a basic listing.", "default": true }, "availabilityCalendar": { "title": "Availability calendar", "type": "boolean", "description": "Get the current month and next eleven months, with daily availability and stay restrictions. Unavailable dates are not proof of bookings.", "default": false }, "currency": { "title": "Currency", "type": "string", "description": "Three-letter currency requested from the site, such as USD, ZAR, EUR or GBP. Prices are displayed quotes, not guaranteed checkout totals.", "default": "USD" }, "language": { "title": "Details and reviews language", "enum": [ "en", "de", "es", "fr", "it", "pt", "nl" ], "type": "string", "description": "Language requested for listing descriptions, policies and review translations. Search titles stay English so location validation and numeric search fields remain consistent. Original review text is kept.", "default": "en" }, "reviewSort": { "title": "Review order", "enum": [ "newest", "relevant", "highest", "lowest" ], "type": "string", "description": "Site-provided review order.", "default": "newest" } } }, "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 } } } } } } } } } }