{
"openapi": "3.0.1",
"info": {
"title": "Airbnb Search Scraper — Listings, Prices & Reviews",
"description": "Extract Airbnb listings for any location worldwide. Get prices, ratings, photos, coordinates, host info, and badges. Optional detail enrichment with amenities, house rules, and host profiles. Auto-segmentation breaks Airbnb's 270-result cap. Fast SSR parsing, no browser needed.",
"version": "0.1",
"x-build-id": "CYWrNYHwZVpSLw3fR"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/rastriq~airbnb-search-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-rastriq-airbnb-search-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/rastriq~airbnb-search-scraper/runs": {
"post": {
"operationId": "runs-sync-rastriq-airbnb-search-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/rastriq~airbnb-search-scraper/run-sync": {
"post": {
"operationId": "run-sync-rastriq-airbnb-search-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",
"required": [
"query"
],
"properties": {
"query": {
"title": "Search location",
"type": "string",
"description": "City, neighborhood, or region to search — exactly as you'd type it on Airbnb.
Examples: New York, NY, Paris, France, Tokyo, Mallorca, Spain"
},
"postalCodes": {
"title": "Postal / zip codes",
"type": "array",
"description": "List of postal codes to search individually. Each code generates a search like {location}, {code}.
Example: [\"10001\", \"10002\", \"10003\"]
Leave empty to search the full location.",
"items": {
"type": "string"
}
},
"maxResults": {
"title": "Max results",
"minimum": 0,
"type": "integer",
"description": "Hard limit on total listings to extract across all zones. The scraper stops immediately when this number is reached. Set to 0 for no limit.",
"default": 0
},
"maxPages": {
"title": "Max pages per segment",
"minimum": 1,
"maximum": 100,
"type": "integer",
"description": "Pages of results per price/type segment. Each page has ~18 listings. Lower values = faster but may miss some results.",
"default": 15
},
"checkin": {
"title": "Check-in date",
"type": "string",
"description": "Format: YYYY-MM-DD. Leave empty for a general search without specific dates."
},
"checkout": {
"title": "Check-out date",
"type": "string",
"description": "Format: YYYY-MM-DD."
},
"adults": {
"title": "Adults",
"minimum": 1,
"maximum": 16,
"type": "integer",
"description": "Number of adult guests.",
"default": 1
},
"children": {
"title": "Children",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Ages 2–12.",
"default": 0
},
"infants": {
"title": "Infants",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Under 2 years old.",
"default": 0
},
"pets": {
"title": "Pets",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Number of pets.",
"default": 0
},
"minPrice": {
"title": "Min price per night",
"minimum": 0,
"type": "integer",
"description": "Minimum nightly price in the selected currency."
},
"maxPrice": {
"title": "Max price per night",
"minimum": 0,
"type": "integer",
"description": "Maximum nightly price in the selected currency."
},
"currency": {
"title": "Currency",
"type": "string",
"description": "ISO 4217 currency code for prices. Examples: USD, EUR, GBP, JPY. Leave empty for Airbnb's default."
},
"roomType": {
"title": "Room type",
"enum": [
"",
"Entire home/apt",
"Private room",
"Shared room",
"Hotel room"
],
"type": "string",
"description": "Filter by accommodation type.",
"default": ""
},
"enrichDetails": {
"title": "Enrich with detail pages",
"type": "boolean",
"description": "When enabled, visits each listing page to extract: full description, complete amenity list, host profile, house rules, property details (beds, baths, max guests), and neighborhood info.",
"default": false
},
"autoSegment": {
"title": "Auto-segmentation",
"type": "boolean",
"description": "Automatically subdivide searches that hit Airbnb's result cap. Disable for a quick sample only.",
"default": true
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Configure proxies to avoid blocks. The default Apify proxy works well for most cases."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}