{
"openapi": "3.0.1",
"info": {
"title": "Airbnb Scraper - Listings, Prices, Ratings & Availability",
"description": "Scrape Airbnb listings by city, map area or search link without the Airbnb API: nightly and total prices, ratings, reviews count, coordinates and photos. Optional details add amenities, capacity, rating breakdown and calendar availability. No login, no start fee. CSV, Excel or JSON.",
"version": "1.0",
"x-build-id": "SRCdnW4Ov9xJgTykf"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/zaver.api~airbnb-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-zaver.api-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/zaver.api~airbnb-scraper/runs": {
"post": {
"operationId": "runs-sync-zaver.api-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/zaver.api~airbnb-scraper/run-sync": {
"post": {
"operationId": "run-sync-zaver.api-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": "Cities, neighbourhoods, regions or countries, one per line, written as you would type them into Airbnb's search box: Lisbon, Portugal, Brooklyn, New York, Bali.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "Airbnb links",
"type": "array",
"description": "Airbnb search links (https://www.airbnb.com/s/Lisbon--Portugal/homes?...) with any filters you set on the site, or listing links (https://www.airbnb.com/rooms/23411393). A search link keeps its own dates and filters.",
"items": {
"type": "string"
}
},
"maxItemsPerLocation": {
"title": "Max listings per location",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "How many listings to return for each location or search link. Airbnb shows about 240 per search; above that, the Actor splits the area into smaller map areas and searches each one.",
"default": 100
},
"checkIn": {
"title": "Check-in",
"type": "string",
"description": "Optional. With dates, prices are for your stay and only available listings are returned. Without dates, Airbnb shows a price for dates it picks."
},
"checkOut": {
"title": "Check-out",
"type": "string",
"description": "Optional. Set together with check-in."
},
"adults": {
"title": "Adults",
"minimum": 0,
"maximum": 16,
"type": "integer",
"description": "Number of adult guests. 0 leaves it unset.",
"default": 0
},
"currency": {
"title": "Currency",
"enum": [
"USD",
"EUR",
"GBP",
"CAD",
"AUD",
"CHF",
"JPY",
"INR",
"BRL",
"MXN",
"SGD",
"AED",
"ZAR",
"SEK",
"NOK",
"DKK",
"PLN",
"THB",
"IDR",
"KRW"
],
"type": "string",
"description": "Currency for prices.",
"default": "USD"
},
"priceMin": {
"title": "Min price per night",
"minimum": 0,
"type": "integer",
"description": "In the selected currency. 0 means no minimum.",
"default": 0
},
"priceMax": {
"title": "Max price per night",
"minimum": 0,
"type": "integer",
"description": "In the selected currency. 0 means no maximum.",
"default": 0
},
"roomType": {
"title": "Type of place",
"enum": [
"any",
"entire_home",
"private_room"
],
"type": "string",
"description": "Entire homes only, private rooms only, or any type.",
"default": "any"
},
"minBedrooms": {
"title": "Min bedrooms",
"minimum": 0,
"maximum": 20,
"type": "integer",
"description": "0 means any.",
"default": 0
},
"includeDetails": {
"title": "Add listing details and availability",
"type": "boolean",
"description": "Opens each listing and adds property type, bedrooms, beds, baths, guest capacity, Superhost flag, the six rating scores, amenities, all photos, exact coordinates and calendar availability for the next 30, 90 and 365 days. Charged as a separate event per listing.",
"default": false
},
"maxItems": {
"title": "Max listings in total",
"minimum": 0,
"maximum": 10000000,
"type": "integer",
"description": "Hard cap on listings for the whole run. 0 means no cap.",
"default": 0
}
}
},
"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
}
}
}
}
}
}
}
}
}
}