{
"openapi": "3.0.1",
"info": {
"title": "Airbnb Scraper",
"description": "Scrape Airbnb listings by location or search link: prices for your dates, ratings, hosts, amenities, house rules, cancellation policy, coordinates, photos and availability calendar. Reads whole cities past Airbnb's 270-result limit. No login, no browser.",
"version": "1.0",
"x-build-id": "Hgt2fGrGnFcDsnh2P"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/steadyscrape~airbnb-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-steadyscrape-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/steadyscrape~airbnb-scraper/runs": {
"post": {
"operationId": "runs-sync-steadyscrape-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/steadyscrape~airbnb-scraper/run-sync": {
"post": {
"operationId": "run-sync-steadyscrape-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, Brooklyn, NY, Bali.",
"items": {
"type": "string"
}
},
"searchUrls": {
"title": "Search links",
"type": "array",
"description": "Airbnb search links, with every filter they carry (dates, guests, price, room type, amenities, and the map area when you moved the map). A link's own filters win over the fields below.",
"items": {
"type": "string"
}
},
"checkIn": {
"title": "Check-in",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string",
"description": "YYYY-MM-DD. With dates, prices are the real totals for that stay and the listings are the available ones. Without dates, Airbnb prices each listing for dates of its own choosing, which the output reports."
},
"checkOut": {
"title": "Check-out",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string",
"description": "YYYY-MM-DD, after check-in."
},
"adults": {
"title": "Adults",
"minimum": 1,
"maximum": 16,
"type": "integer",
"description": "Guests aged 13 or more.",
"default": 1
},
"children": {
"title": "Children",
"minimum": 0,
"maximum": 15,
"type": "integer",
"description": "Guests aged 2 to 12.",
"default": 0
},
"infants": {
"title": "Infants",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Guests under 2.",
"default": 0
},
"pets": {
"title": "Pets",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Pets travelling with the guests.",
"default": 0
},
"currency": {
"title": "Currency",
"type": "string",
"description": "3-letter code for every price in the output: USD, EUR, GBP…",
"default": "USD"
},
"priceMin": {
"title": "Min price per night",
"minimum": 0,
"type": "integer",
"description": "In the currency above; 0 means no minimum.",
"default": 0
},
"priceMax": {
"title": "Max price per night",
"minimum": 0,
"type": "integer",
"description": "In the currency above; 0 means no maximum.",
"default": 0
},
"roomTypes": {
"title": "Room types",
"type": "array",
"description": "Leave empty for all.",
"items": {
"type": "string",
"enum": [
"Entire home/apt",
"Private room",
"Shared room",
"Hotel room"
],
"enumTitles": [
"Entire home",
"Private room",
"Shared room",
"Hotel room"
]
},
"default": []
},
"minBedrooms": {
"title": "Min bedrooms",
"minimum": 0,
"maximum": 50,
"type": "integer",
"description": "0 means no minimum.",
"default": 0
},
"minBeds": {
"title": "Min beds",
"minimum": 0,
"maximum": 50,
"type": "integer",
"description": "0 means no minimum.",
"default": 0
},
"minBathrooms": {
"title": "Min bathrooms",
"minimum": 0,
"maximum": 50,
"type": "integer",
"description": "0 means no minimum.",
"default": 0
},
"maxListingsPerSearch": {
"title": "Max listings per search",
"minimum": 0,
"type": "integer",
"description": "Stop each location or link after this many listings. 0 means all of them.",
"default": 0
},
"fullCoverage": {
"title": "Full coverage",
"type": "boolean",
"description": "Airbnb pages through at most 270 listings per search. When a place has more, read its whole map area cell by cell instead, so every listing is returned. Costs more search requests; turn off to get only Airbnb's top 270.",
"default": true
},
"areaScale": {
"title": "Area scale",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "For full coverage of a place: the map area Airbnb centers on the place, with each side multiplied by this. 1 is just the center; 3 (default) covers a city; 5 or more covers its surroundings too. Ignored for links with their own map area.",
"default": 3
},
"includeDetails": {
"title": "Include listing details",
"type": "boolean",
"description": "Read each listing's page too: description, all amenities, host profile, house rules, safety, cancellation policy for your dates, category ratings, rating distribution, review tags, neighborhood notes, all photos with captions, sleeping arrangement. One extra request per listing.",
"default": false
},
"calendarMonths": {
"title": "Availability calendar months",
"minimum": 0,
"maximum": 12,
"type": "integer",
"description": "Read each listing's availability day by day for this many months from now (0 = none): available, check-in and check-out allowed, minimum and maximum nights. One extra request per listing.",
"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
}
}
}
}
}
}
}
}
}
}