{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper: Listings, Prices, Reviews & Availability", "description": "Extract Airbnb listings, vacation rentals and short-term rental data from any destination. Get nightly prices, ratings, guest reviews, photos, coordinates, amenities and host details, plus 365-day availability and occupancy. Export to JSON, CSV or Excel. $1.99 per 1,000 results.", "version": "0.1", "x-build-id": "DS3AZ49PamUA3NyHr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sourabhbgp~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sourabhbgp-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/sourabhbgp~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-sourabhbgp-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/sourabhbgp~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-sourabhbgp-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": { "mode": { "title": "Mode", "enum": [ "search", "listing", "reviews" ], "type": "string", "description": "Scraping mode: search for listings by location, get listing details, or scrape reviews.", "default": "search" }, "locationQueries": { "title": "Location Queries", "type": "array", "description": "Location names to search for listings (used in search mode). Examples: New York, Paris, Tokyo.", "items": { "type": "string" } }, "urls": { "title": "Listing URLs", "type": "array", "description": "Airbnb listing URLs for listing/reviews mode. Also accepts bare listing IDs.", "items": { "type": "string" } }, "maxResults": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of results to return. 0 = unlimited.", "default": 50 }, "checkIn": { "title": "Check-in Date", "type": "string", "description": "Check-in date for search (YYYY-MM-DD)." }, "checkOut": { "title": "Check-out Date", "type": "string", "description": "Check-out date for search (YYYY-MM-DD)." }, "priceMin": { "title": "Minimum Price", "type": "integer", "description": "Minimum price per night filter." }, "priceMax": { "title": "Maximum Price", "type": "integer", "description": "Maximum price per night filter." }, "currency": { "title": "Currency", "type": "string", "description": "Currency code for prices (e.g., USD, EUR, GBP).", "default": "USD" }, "roomType": { "title": "Room Type", "enum": [ "any", "Entire home/apt", "Private room", "Shared room" ], "type": "string", "description": "Filter by room type.", "default": "any" }, "minBedrooms": { "title": "Minimum Bedrooms", "type": "integer", "description": "Minimum number of bedrooms." }, "minBathrooms": { "title": "Minimum Bathrooms", "type": "integer", "description": "Minimum number of bathrooms." }, "adults": { "title": "Number of Adults", "minimum": 1, "type": "integer", "description": "Number of adult guests.", "default": 1 }, "superhostOnly": { "title": "Superhost Only", "type": "boolean", "description": "Only show listings from Superhosts.", "default": false }, "includeAvailabilityCalendar": { "title": "Include availability calendar", "type": "boolean", "description": "Listing mode only. Adds a per-day availability calendar of up to 365 days to each listing, showing which dates are free and the minimum stay for each. Occupancy rate is always included and does not need this option.", "default": false }, "includeHostPortfolio": { "title": "Include host portfolio", "type": "boolean", "description": "Listing mode only. Adds every other listing the same host manages, with room type, bed and bath counts. Uses one extra request per host.", "default": false } } }, "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 } } } } } } } } } }