{ "openapi": "3.0.1", "info": { "title": "Airbnb Listings Scraper (search + details + reviews)", "description": "Airbnb search results and full listing details for any location: price, rating, host, amenities, coordinates, reviews. Beats the ~270-result cap with automatic price-band splitting. Plain HTTP, pay per listing.", "version": "0.1", "x-build-id": "OdLyGYTaYZqdDamS5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ceo.sss~airbnb-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ceo.sss-airbnb-listings-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/ceo.sss~airbnb-listings-scraper/runs": { "post": { "operationId": "runs-sync-ceo.sss-airbnb-listings-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/ceo.sss~airbnb-listings-scraper/run-sync": { "post": { "operationId": "run-sync-ceo.sss-airbnb-listings-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": { "locationQueries": { "title": "Locations", "type": "array", "description": "Places to search, exactly as you would type them on Airbnb: \"Lisbon, Portugal\", \"Goa, India\", \"Brooklyn, NY\". One search per entry.", "items": { "type": "string" } }, "startUrls": { "title": "Airbnb search URLs", "type": "array", "description": "Airbnb search URLs copied from your browser (https://www.airbnb.com/s//homes?...). Every filter in the URL is honoured (map bounds, amenities, guest favourites, flexible dates...). URL filters override the fields below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "checkIn": { "title": "Check-in", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD. With dates, prices are exact for that stay. Without dates Airbnb quotes each listing for dates it picks itself (see checkIn/checkOut on every row)." }, "checkOut": { "title": "Check-out", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD. Required together with checkIn." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests. Affects availability and price.", "default": 2 }, "currency": { "title": "Currency", "pattern": "^[A-Za-z]{3}$", "type": "string", "description": "ISO code (USD, EUR, INR, GBP...). Prices and price bands are in this currency.", "default": "USD" }, "priceMin": { "title": "Min price per night", "minimum": 0, "type": "integer", "description": "In the selected currency." }, "priceMax": { "title": "Max price per night", "minimum": 0, "type": "integer", "description": "In the selected currency. Per night." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Only listings with at least this many bedrooms." }, "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/apt", "Private room", "Shared room", "Hotel room" ] } }, "maxListingsPerQuery": { "title": "Max listings per search", "minimum": 1, "type": "integer", "description": "Airbnb returns at most ~270 per search. Ask for more and the actor automatically re-runs the search per price band (using Airbnb's own price histogram) until it has enough or the bands are exhausted.", "default": 100 }, "maxItems": { "title": "Max listings total", "minimum": 1, "type": "integer", "description": "Hard cap across all searches." }, "includeDetails": { "title": "Fetch listing details", "type": "boolean", "description": "One extra request per listing: amenities, description, host profile, rating breakdown, house rules, cancellation policy, up to 20 photos, exact room type. Charged as 'listing-details'.", "default": false }, "includeReviews": { "title": "Fetch reviews", "type": "boolean", "description": "One extra request per 24 reviews per listing. Charged per review.", "default": false }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 1, "maximum": 500, "type": "integer", "description": "Newest first. 24 reviews per request.", "default": 20 }, "minDelayMs": { "title": "Min delay between requests (ms)", "minimum": 0, "type": "integer", "description": "Pause between requests to Airbnb (per run). Lower is faster but gets a session blocked sooner.", "default": 1500 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy recommended: Airbnb answers datacenter IPs with 403 far more often. Sessions rotate automatically on 403/429.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }