{
"openapi": "3.0.1",
"info": {
"title": "Airbnb Scraper 🏠: prices, ratings + availability calendar",
"description": "Scrape Airbnb listings with accurate nightly prices pulled from the real price breakdown, not rough estimates. Get ratings, reviews, coordinates, host type and each listing's day-by-day availability calendar. It tiles the map so you get every listing in the city, not just the ~270 a search caps at.",
"version": "0.1",
"x-build-id": "qdbVXiwa5OSDQDzEL"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/tagadanar~airbnb-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-tagadanar-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/tagadanar~airbnb-scraper/runs": {
"post": {
"operationId": "runs-sync-tagadanar-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/tagadanar~airbnb-scraper/run-sync": {
"post": {
"operationId": "run-sync-tagadanar-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": {
"searchUrls": {
"title": "Airbnb search URLs",
"type": "array",
"description": "Paste one or more Airbnb search-results URLs — build the search on airbnb.com (any airbnb.* domain works) with your filters/dates and copy the page URL, e.g. https://www.airbnb.com/s/Paris/homes.",
"items": {
"type": "string"
}
},
"locationQueries": {
"title": "Or just place names",
"type": "array",
"description": "Alternative to URLs: plain place names (e.g. Lisbon, Nice, France). Combine with the check-in/check-out fields below.",
"default": [],
"items": {
"type": "string"
}
},
"checkIn": {
"title": "Check-in date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string",
"description": "Optional, YYYY-MM-DD. Applied to locationQueries searches (URLs keep their own dates). Dated searches return exact quoted prices."
},
"checkOut": {
"title": "Check-out date",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string",
"description": "Optional, YYYY-MM-DD."
},
"adults": {
"title": "Adults",
"minimum": 1,
"maximum": 16,
"type": "integer",
"description": "Optional guest count for locationQueries searches."
},
"children": {
"title": "Children",
"minimum": 0,
"maximum": 15,
"type": "integer",
"description": "Optional. Number of children (locationQueries searches)."
},
"infants": {
"title": "Infants",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Optional. Number of infants under 2 (locationQueries searches)."
},
"pets": {
"title": "Pets",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Optional. Number of pets — only pet-friendly listings are returned (locationQueries searches)."
},
"currency": {
"title": "Currency",
"type": "string",
"description": "Optional ISO code (e.g. USD, EUR). Forces all prices into this currency."
},
"includeCalendar": {
"title": "Include availability calendar",
"type": "boolean",
"description": "Attach each listing's raw availability calendar (per-day available / minNights / bookable) — the data other Airbnb scrapers don't return. Adds one light API call per listing.",
"default": false
},
"calendarMonths": {
"title": "Calendar months ahead",
"minimum": 1,
"maximum": 12,
"type": "integer",
"description": "How many months of forward availability to read per listing.",
"default": 6
},
"onlyPrivateHost": {
"title": "Private hosts only",
"type": "boolean",
"description": "Keep only listings hosted by a private individual, dropping professional property managers.",
"default": false
},
"minPrice": {
"title": "Minimum nightly price",
"minimum": 0,
"type": "integer",
"description": "Keep only listings at or above this nightly price. For place-name searches it is applied inside the Airbnb search itself (faster)."
},
"maxPrice": {
"title": "Maximum nightly price",
"minimum": 0,
"type": "integer",
"description": "Keep only listings at or below this nightly price. For place-name searches it is applied inside the Airbnb search itself (faster)."
},
"minBedrooms": {
"title": "Minimum bedrooms",
"minimum": 1,
"maximum": 8,
"type": "integer",
"description": "Only listings with at least this many bedrooms (locationQueries searches)."
},
"minBeds": {
"title": "Minimum beds",
"minimum": 1,
"maximum": 8,
"type": "integer",
"description": "Only listings with at least this many beds (locationQueries searches)."
},
"minBathrooms": {
"title": "Minimum bathrooms",
"minimum": 1,
"maximum": 8,
"type": "integer",
"description": "Only listings with at least this many bathrooms (locationQueries searches)."
},
"minRating": {
"title": "Minimum rating",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Keep only listings with at least this average rating (whole number, out of 5)."
},
"minReviews": {
"title": "Minimum reviews",
"minimum": 0,
"type": "integer",
"description": "Keep only listings with at least this many reviews."
},
"propertyTypes": {
"title": "Property types",
"type": "array",
"description": "Keep only listings whose type contains one of these words (e.g. Apartment, House). Empty = all.",
"default": [],
"items": {
"type": "string"
}
},
"monitorMode": {
"title": "Monitor mode (new listings only)",
"type": "boolean",
"description": "Remember what previous runs reported (per monitorName) and return only new listings. Schedule it for a live feed of fresh supply — you're charged for new listings only.",
"default": false
},
"monitorName": {
"title": "Monitor name",
"type": "string",
"description": "Name for this watch's memory of already-seen listings. Use a distinct name per saved search.",
"default": "default"
},
"webhookUrl": {
"title": "Slack / webhook URL",
"type": "string",
"description": "Optional. A Slack incoming-webhook URL (or any endpoint) that receives a digest of the new listings — pairs with monitor mode + a schedule."
},
"maxListings": {
"title": "Max listings",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Stop after this many unique listings across all searches.",
"default": 300
}
}
},
"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
}
}
}
}
}
}
}
}
}
}