{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper: Listings, Prices, Hosts, Amenities, Ratings", "description": "Airbnb scraper for listings by city search or room URL: title, property type, location and coordinates, beds, baths, rating, review count, host, amenities, photos and the price for your dates. One cheap Actor, plain HTTP, no browser, no login.", "version": "0.1", "x-build-id": "l1oufeBTgqu8EjvRk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datagleaner~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datagleaner-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/datagleaner~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-datagleaner-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/datagleaner~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-datagleaner-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": "Places to search, as you would type them on Airbnb: `Lisbon, Portugal`, `Austin, TX`, `Bali`. Each place returns up to `maxItems` listings, up to 270 per place (Airbnb shows 15 result pages of 18).", "items": { "type": "string" } }, "roomUrls": { "title": "Room URLs or IDs", "type": "array", "description": "Room mode: Airbnb room URLs (`https://www.airbnb.com/rooms/20669368`) or bare room IDs. Each returns the full listing record. Any airbnb domain works. Rooms that no longer exist are skipped and not charged.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD. Set both dates to get a `price` for your stay on search results. Leave both empty and a location search prices a 2-night stay starting 14 days from the run date for 2 adults (the dates used are echoed on every item as `checkIn` and `checkOut`)." }, "checkOut": { "title": "Check-out date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD, after check-in. Empty with no check-in: the default 2-night stay applies." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests the price is for. Used for the price, with your dates or with the default stay.", "default": 2 }, "currency": { "title": "Currency", "type": "string", "description": "ISO 4217 code for prices, e.g. `USD`, `EUR`, `GBP`, `JPY`.", "default": "USD" }, "maxItems": { "title": "Max listings per location", "minimum": 1, "maximum": 270, "type": "integer", "description": "Stops after this many listings for each place in `locations`. Room URLs are not limited by it.", "default": 20 }, "includeDetails": { "title": "Fetch full listing details", "type": "boolean", "description": "One extra request per search result adds amenities, host, all photos, country, guest capacity, description and rating breakdown. Turn off for a faster, lighter list from the search cards only (the price, rating, beds and coordinates stay).", "default": true }, "requestDelaySecs": { "title": "Delay between requests (seconds)", "minimum": 0.2, "type": "number", "description": "Polite pacing. Lower is faster and raises the chance of being blocked.", "default": 0.7 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Off by default: Airbnb answered Apify datacenter IPs in testing. Enable a proxy if runs start getting blocked at high volume." } } }, "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 } } } } } } } } } }