{ "openapi": "3.0.1", "info": { "title": "Airbnb Scraper & Market Monitor", "description": "Reliable Airbnb scraper: location/URL search, property details, availability calendar (with prices), and reviews in one Actor — plus an incremental monitoring mode that tracks new listings, price changes, availability changes and delistings over time. Public listing & host-operational data only.", "version": "0.1", "x-build-id": "GJz26VYa312apf93c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapesage~airbnb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~airbnb-scraper/runs": { "post": { "operationId": "runs-sync-scrapesage-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/scrapesage~airbnb-scraper/run-sync": { "post": { "operationId": "run-sync-scrapesage-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": { "locationQueries": { "title": "Location queries", "type": "array", "description": "Free-text locations to search, e.g. \"London\", \"Miami Beach, FL\", \"Lisbon, Portugal\". Each becomes an Airbnb search.", "items": { "type": "string" } }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Pre-filtered Airbnb search result URLs (paste from your browser after applying filters not exposed below, e.g. instant book, specific amenities). One URL per line.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs", "type": "array", "description": "Direct Airbnb property/room URLs (e.g. https://www.airbnb.com/rooms/12345678). Scraped as individual properties — no separate Actor needed.", "items": { "type": "string" } }, "checkIn": { "title": "Check-in (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Check-in date. Affects price and availability. Leave empty for undated search." }, "checkOut": { "title": "Check-out (YYYY-MM-DD)", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Check-out date. Must be after check-in." }, "adults": { "title": "Adults", "minimum": 0, "type": "integer", "description": "Number of adult guests.", "default": 1 }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Number of children (ages 2–12).", "default": 0 }, "infants": { "title": "Infants", "minimum": 0, "type": "integer", "description": "Number of infants (under 2).", "default": 0 }, "pets": { "title": "Pets", "minimum": 0, "type": "integer", "description": "Number of pets.", "default": 0 }, "priceMin": { "title": "Min price (per night)", "minimum": 0, "type": "integer", "description": "Minimum nightly price in the chosen currency." }, "priceMax": { "title": "Max price (per night)", "minimum": 0, "type": "integer", "description": "Maximum nightly price in the chosen currency." }, "minBeds": { "title": "Min beds", "minimum": 0, "type": "integer", "description": "Minimum number of beds." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bathrooms." }, "propertyTypes": { "title": "Room / property types", "type": "array", "description": "Filter by Airbnb room type. Allowed values: \"Entire home/apt\", \"Private room\", \"Shared room\", \"Hotel room\". Unknown values are ignored.", "items": { "type": "string" } }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "JPY", "CNY", "INR", "BRL", "MXN", "CHF", "SEK", "NOK", "DKK", "PLN", "ZAR", "AED", "SGD", "HKD", "NZD" ], "type": "string", "description": "Currency for all prices.", "default": "USD" }, "locale": { "title": "Locale", "enum": [ "en", "en-GB", "fr", "de", "es", "it", "pt", "nl", "ja", "zh", "ru", "ko", "pl", "sv", "da", "nb" ], "type": "string", "description": "Language/locale for content.", "default": "en" }, "skipDetailPages": { "title": "Skip detail pages (faster, less data)", "type": "boolean", "description": "Default is OFF (unchecked) = scrape FULL detail for every listing: description, amenities, accessibility, house rules, registration number, full photo gallery, and host data (id, Superhost, verified, rating, time as host, response rate/time) — the richest output. Turn this ON (checked) for a fast, cheap SEARCH-ONLY run that returns just card data: title, price, rating, coordinates, badges, Superhost/Guest-favorite, thumbnail (~1 fetch per ~18 listings, a full city in ~1-2 min). A single listing URL you pass directly is always fetched in full regardless of this toggle.", "default": false }, "calendarMonths": { "title": "Calendar months", "minimum": 0, "maximum": 12, "type": "integer", "description": "Months of future availability + nightly price to fetch per listing (0 = none). Each month is one extra request per listing.", "default": 0 }, "scrapeReviews": { "title": "Scrape reviews", "type": "boolean", "description": "Default is ON. Fetch reviews (text, rating, date, language, opaque reviewer ID only — never reviewer name/photo/profile). Turn off to skip reviews for a lighter, cheaper run.", "default": true }, "maxReviewsPerListing": { "title": "Max reviews per listing", "minimum": 0, "type": "integer", "description": "Cap reviews fetched per listing. Defaults to 50 to bound cost/time on listings with hundreds of reviews; set 0 for unlimited (Airbnb's full set). Only applies when 'Scrape reviews' is on.", "default": 50 }, "maxListings": { "title": "Max listings", "minimum": 0, "type": "integer", "description": "Stop after this many unique listings across all sources. Defaults to 100 to keep runs fast and costs predictable; raise it for bigger pulls. Set 0 for unlimited (a dense city can return many thousands via price-band splitting — only use 0 if you intend a full, potentially large/expensive crawl).", "default": 100 }, "priceSplitCeiling": { "title": "Price-split ceiling (advanced)", "minimum": 0, "type": "integer", "description": "Upper price bound for the price-band splitting algorithm when a search hits the ~270 cap (NOT a listing filter). 0 = automatic. Higher values probe more of the long price tail.", "default": 0 }, "enableMapSplit": { "title": "Enable map splitting (dense areas)", "type": "boolean", "description": "Recursively subdivide the map viewport into quadrants when price-band splitting still hits the cap. Useful for dense cities.", "default": false }, "incrementalMode": { "title": "Incremental monitoring mode", "type": "boolean", "description": "Track a market over time. First run captures a baseline; later runs emit only changes (new / price / availability / rating / delisted). Requires a Monitor key.", "default": false }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Stable name for the market you are monitoring (e.g. \"lisbon-2br\"). State is persisted in a named Key-Value store across runs. Required when monitoring is on." }, "trackPriceChanges": { "title": "Track price changes", "type": "boolean", "description": "Emit priceChanged records with old → new price and delta.", "default": true }, "trackAvailabilityChanges": { "title": "Track availability changes", "type": "boolean", "description": "Emit availabilityChanged records when a listing opens/closes for the monitored dates.", "default": true }, "detectDelistings": { "title": "Detect delistings", "type": "boolean", "description": "After scanning the whole market, emit delisted records for listings seen before but now absent.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. Defaults to fast, low-cost datacenter proxies with automatic fallback to residential when Airbnb blocks datacenter — the cheapest option that still works reliably. For maximum reliability you can force residential by selecting the RESIDENTIAL group.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum parallel requests. Keep conservative (5–10) to avoid blocks.", "default": 8 }, "maxRequestsPerMinute": { "title": "Max requests per minute", "minimum": 1, "type": "integer", "description": "Global request rate cap (throttling helps avoid 429s).", "default": 120 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 15, "type": "integer", "description": "Retries per request before a listing/search is classified and skipped (the run does not fail).", "default": 5 } } }, "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 } } } } } } } } } }