# Airbnb Scraper & Market Monitor (`scrapesage/airbnb-scraper`) Actor 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. - **URL**: https://apify.com/scrapesage/airbnb-scraper.md - **Developed by:** [Scrape Sage](https://apify.com/scrapesage) (community) - **Categories:** Travel, Real estate, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing $2.00 / 1,000 listing scrapeds This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Airbnb Scraper & Market Monitor Scrape **Airbnb listings, prices, availability calendars, host operational data, and reviews** by location, search URL, or direct room URL — then re-run in **incremental monitoring mode** to track new listings, price changes, availability changes, and delistings over time. Public listing and host-operational data only. ### Why this Airbnb scraper? | | Typical Airbnb scrapers | This actor | |---|---|---| | Coverage | search OR detail OR reviews, often split across separate actors | search + property detail + availability calendar + reviews in one run | | Result depth | capped at Airbnb's ~270 results per search | automatic price-band splitting (plus optional map subdivision) to go beyond the cap | | Change tracking | one-off snapshots only | built-in incremental monitoring of new / price / availability / delisted listings | | Proxy strategy | residential-only (expensive) or fragile datacenter-only | datacenter-first with automatic residential fallback on blocks | | Cost fairness | charged for empty / unavailable results | empty, unavailable, delisted, and zero-result outcomes are reported as success, not charged | | Privacy | scrapes host/reviewer personal profiles | public listing and host-operational data only — no host or reviewer names, photos, or profiles | ### Use cases - **Short-term-rental revenue management** — pull nightly prices and the availability calendar across a market to benchmark your own listing and set competitive rates. - **STR investment research** — measure supply, property mix, ratings, and Superhost density in a target city before buying. - **Market monitoring** — schedule incremental runs to catch price moves, newly listed properties, and delistings the day they happen. - **Compliance and registration checks** — collect the property registration / license number (e.g. an AL number) shown in regulated markets. - **Travel and accessibility analysis** — gather amenities, accessibility features, house rules, and full photo galleries for filtered, structured comparison. ### How to use 1. [Sign up for Apify](https://console.apify.com/sign-up) — the free plan is enough to try this actor. 2. Open the **Airbnb Scraper & Market Monitor**, fill in the inputs you need, and click **Start**. 3. Watch results stream into the dataset table as each record is parsed. 4. **Export** as JSON, CSV, Excel, XML, or RSS — or pull results programmatically via the [Apify API](https://docs.apify.com/api/v2). ### Input Provide at least one source: location queries, pre-filtered search URLs, or direct listing URLs. Out of the box the actor returns the **richest** data — detail pages are ON (`skipDetailPages: false`) and reviews are ON (`scrapeReviews: true`). Set `skipDetailPages: true` for a fast, cheap search-only run, and/or `scrapeReviews: false` to skip reviews. ```json { "locationQueries": ["Lisbon, Portugal"], "checkIn": "2026-07-01", "checkOut": "2026-07-05", "adults": 2, "currency": "EUR", "calendarMonths": 2, "scrapeReviews": true, "maxReviewsPerListing": 50, "maxListings": 200, "proxyConfiguration": { "useApifyProxy": true } } ```` Core fields: - **`locationQueries`** — free-text locations to search, e.g. `"London"`, `"Lisbon, Portugal"`. Each becomes an Airbnb search. - **`searchUrls`** — pre-filtered Airbnb search result URLs pasted from your browser after applying filters not exposed below (e.g. instant book, specific amenities). - **`listingUrls`** — direct Airbnb property/room URLs (e.g. `https://www.airbnb.com/rooms/12345678`). A directly supplied listing URL is always fetched in full regardless of `skipDetailPages`. - **`checkIn` / `checkOut`** — `YYYY-MM-DD` dates that affect price and availability; leave empty for an undated search. - **`adults` / `children` / `infants` / `pets`** — guest counts (default 1 adult). - **`priceMin` / `priceMax` / `minBeds` / `minBedrooms` / `minBathrooms`** — search filters in the chosen currency / counts. - **`propertyTypes`** — filter by room type: `Entire home/apt`, `Private room`, `Shared room`, `Hotel room` (unknown values are ignored). - **`currency`** — currency for all prices (default `USD`; 20 options including EUR, GBP, SGD, JPY). - **`locale`** — language/locale for content (default `en`). - **`skipDetailPages`** — OFF by default for full detail per listing; ON for fast search-card-only output. - **`calendarMonths`** — months of future availability + nightly price to fetch per listing (0–12, default 0; each month is one extra request). - **`scrapeReviews` / `maxReviewsPerListing`** — reviews are ON by default, capped at 50 per listing (set 0 for unlimited). - **`maxListings`** — stop after this many unique listings across all sources (default 100; set 0 for unlimited). - **`priceSplitCeiling` / `enableMapSplit`** — advanced controls for splitting past Airbnb's ~270-result search cap by price band and (optionally) map area. - **`proxyConfiguration`** — defaults to datacenter proxies with automatic residential fallback on blocks; force residential by selecting the RESIDENTIAL group. - **`maxConcurrency` / `maxRequestsPerMinute` / `maxRequestRetries`** — tuning knobs to stay polite and avoid blocks. ### Output Each listing is one dataset record (status `ok`). Fields appear only when present at the source or enabled by input — `calendar` requires `calendarMonths > 0`, `isAvailable` requires check-in/out dates, `rating` is omitted entirely when a listing has no reviews, and `registrationNumber` appears in regulated markets. Host data is public/operational only — never host name, photo, profile, or personal attributes. ```json { "id": "12345678", "url": "https://www.airbnb.com/rooms/12345678", "title": "Sunny Studio in Alfama", "propertyType": "Entire rental unit", "roomType": "Entire home/apt", "personCapacity": 4, "minNights": 2, "registrationNumber": "AL/12345", "coordinates": { "lat": 38.7139, "lng": -9.1334 }, "location": "Lisbon, Portugal", "pricing": { "price": { "value": 95, "currency": "EUR" }, "priceLabel": "€95 per night" }, "rating": { "guestSatisfaction": 4.92, "cleanliness": 4.95, "reviewsCount": 218 }, "isGuestFavorite": true, "badges": ["Superhost", "Guest favorite"], "host": { "hostId": "host-77", "isSuperhost": true, "isVerified": true, "ratingAverage": 4.9, "ratingCount": 540, "timeAsHost": { "years": 6, "months": 4 }, "responseRate": 100, "responseTime": "within an hour" }, "amenities": [{ "title": "Bathroom", "values": [{ "title": "Hair dryer" }] }], "images": [{ "url": "https://.../1.jpg", "caption": "Living room", "orientation": "LANDSCAPE" }], "calendar": [{ "date": "2026-07-01", "available": true, "minNights": 2, "price": { "value": 110 } }], "reviews": [{ "reviewId": "rev-1", "text": "Amazing stay!", "rating": 5, "createdAtISO": "2026-05-01T10:00:00.000Z", "language": "en", "reviewerId": "user-501" }], "isAvailable": true, "sourceType": "locationQuery", "sourceQuery": "Lisbon, Portugal", "fetchTier": "ssr-json", "status": "ok", "scrapedAt": "2026-06-14T09:00:00.000Z" } ``` Notes: - **Empty results are reported as success, not errors.** When a listing isn't bookable for the dates, is delisted, or a search genuinely returns nothing, the record carries `status: "empty"` with a plain-English `reason` — these are not charged. - **No personal data.** Host records hold only operational signals (opaque `hostId`, Superhost/verified flags, rating average/count, time as host, response rate/time). Reviews keep text, rating, date, language, and an opaque `reviewerId` only — never a reviewer name or photo. - A final non-charged **run-summary** record (`recordType: "runSummary"`) is emitted at the end with run statistics. - `changeType` (`new`, `priceChanged`, `availabilityChanged`, `delisted`, `unchanged`) is set only in incremental monitoring runs. ### Monitoring — get only new listings Turn on **`incrementalMode`** and set a stable **`monitorKey`** (e.g. `"lisbon-2br"`) to track a market over time. State is persisted in a named Key-Value store across runs: - The **first run** captures a baseline of the whole market. - **Later runs** emit only changes — `new` listings, `priceChanged` (old → new price and delta), `availabilityChanged`, and `delisted` records for listings seen before but now absent. - Toggle exactly which changes you want with **`trackPriceChanges`**, **`trackAvailabilityChanges`**, and **`detectDelistings`**. A monitoring run that finds no changes costs about the actor-start only. Pair it with [Apify Schedules](https://docs.apify.com/platform/schedules) to run hourly or daily and keep your market view fresh. ```json { "locationQueries": ["Lisbon, Portugal"], "checkIn": "2026-07-01", "checkOut": "2026-07-05", "calendarMonths": 1, "incrementalMode": true, "monitorKey": "lisbon-2br-summer", "trackPriceChanges": true, "trackAvailabilityChanges": true, "detectDelistings": true } ``` ### Automate & schedule Run this actor on autopilot and pull results into your own stack: - **[Apify API](https://docs.apify.com/api/v2)** — start runs, fetch datasets, and manage schedules over REST. - **[apify-client for JavaScript](https://docs.apify.com/api/client/js/)** and **[apify-client for Python](https://docs.apify.com/api/client/python/)** — official SDKs. - **[Schedules](https://docs.apify.com/platform/schedules)** — run it on a cron to keep your data fresh. - **[Webhooks](https://docs.apify.com/platform/integrations/webhooks)** — trigger downstream actions the moment a run finishes. ```js import { ApifyClient } from 'apify-client'; const client = new ApifyClient({ token: 'MY_APIFY_TOKEN' }); const run = await client.actor('scrapesage/airbnb-scraper').call({ locationQueries: ['Lisbon, Portugal'], checkIn: '2026-07-01', checkOut: '2026-07-05', adults: 2, currency: 'EUR', calendarMonths: 2, maxListings: 200, }); const { items } = await client.dataset(run.defaultDatasetId).listItems(); console.log(`Got ${items.length} records`); ``` ### Integrate with any app Connect the dataset to 5,000+ apps — no code required: - **[Make](https://docs.apify.com/platform/integrations/make)** — multi-step automation scenarios. - **[Zapier](https://docs.apify.com/platform/integrations/zapier)** — push new records straight into your CRM or sheet. - **[Slack](https://docs.apify.com/platform/integrations/slack)** — get notified when a run finds something new. - **[Google Drive / Sheets](https://docs.apify.com/platform/integrations/drive)** — auto-export every run to a spreadsheet. - **[Airbyte](https://docs.apify.com/platform/integrations/airbyte)** — pipe results into your data warehouse. - **[GitHub](https://docs.apify.com/platform/integrations/github)** — trigger runs from commits or releases. ### Use with AI assistants (MCP) The output is clean, LLM-ready JSON. Call this actor from Claude, ChatGPT, or any agent framework through the **[Apify MCP server](https://docs.apify.com/platform/integrations/mcp)** — ask your assistant to "find available 2-bedroom Airbnbs in Lisbon for next month under €150 a night with their ratings and host response times" and let it run this scraper for you. ### More scrapers from scrapesage Need data from somewhere else? Try these: - [99.co Property Scraper](https://apify.com/scrapesage/99-co-property-scraper) — Singapore property listings, prices & agent leads. - [EdgeProp Singapore Scraper](https://apify.com/scrapesage/edgeprop-singapore-scraper) — Singapore property & agent leads. - [SGCarMart Used Car Scraper](https://apify.com/scrapesage/sgcarmart-used-car-scraper) — Singapore used-car prices, COE/OMV/ARF & dealer leads. - [Eventbrite Scraper](https://apify.com/scrapesage/eventbrite-scraper) — events plus organizer leads with contacts. - [Facebook Ad Library Scraper](https://apify.com/scrapesage/facebook-ad-library-scraper) — Meta/Instagram competitor ad intelligence. - [Google Ads Transparency Scraper](https://apify.com/scrapesage/google-ads-transparency-scraper) — see who's advertising what on Google. - [Telegram Scraper](https://apify.com/scrapesage/telegram-scraper) — channels, messages, media & search. ### Tips - **Leave detail and reviews on for the richest data**, but flip `skipDetailPages: true` (and `scrapeReviews: false`) for a fast, cheap survey of a whole city in search-card form. - **Set `checkIn`/`checkOut`** to get accurate dated pricing, the `isAvailable` flag, and a meaningful availability calendar; an undated search returns generic prices. - **To exceed Airbnb's ~270-result-per-search cap**, raise `maxListings` and let price-band splitting work; for very dense cities also enable `enableMapSplit`. - **For monitoring, keep the same `monitorKey`** across runs so state carries over — changing it starts a fresh baseline. - **Start on the default datacenter proxy** (cheapest) and only force RESIDENTIAL if you see persistent blocks; keep `maxConcurrency` conservative (5–10). ### FAQ **What data does this actor collect?** Public Airbnb listing data: title, property/room type, pricing, availability calendar with nightly prices, ratings, amenities, accessibility features, house rules, photo galleries, registration/license numbers where shown, reviews, and host operational signals. **Does it collect host or reviewer personal information?** No. It captures host-operational data only (opaque ID, Superhost/verified flags, ratings, time as host, response rate/time) and review text with an opaque reviewer ID — never names, photos, profiles, or personal attributes. **Can I get more than Airbnb's ~270 results per search?** Yes. When a search hits the cap, the actor splits it by price band (and optionally by map area for dense cities) and dedupes by listing ID, so you can pull thousands. **Am I charged for empty or unavailable listings?** No. Empty, unavailable, delisted, and zero-result outcomes are reported as successful, self-explaining records and are not charged; the final run-summary record is also free. **How do I export the data?** Export any run as JSON, CSV, Excel, XML, or RSS from the dataset, or pull it programmatically via the Apify API and the JavaScript/Python clients. **Do I need a login or cookies?** No. The actor works over public Airbnb endpoints with proxy rotation — no account, login, or cookies required. ### Need help? Open an issue on the actor's **Issues** tab, or visit the [Apify help center](https://help.apify.com/). Feature requests are welcome — this actor is actively maintained. # Actor input Schema ## `locationQueries` (type: `array`): Free-text locations to search, e.g. "London", "Miami Beach, FL", "Lisbon, Portugal". Each becomes an Airbnb search. ## `searchUrls` (type: `array`): 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. ## `listingUrls` (type: `array`): Direct Airbnb property/room URLs (e.g. https://www.airbnb.com/rooms/12345678). Scraped as individual properties — no separate Actor needed. ## `checkIn` (type: `string`): Check-in date. Affects price and availability. Leave empty for undated search. ## `checkOut` (type: `string`): Check-out date. Must be after check-in. ## `adults` (type: `integer`): Number of adult guests. ## `children` (type: `integer`): Number of children (ages 2–12). ## `infants` (type: `integer`): Number of infants (under 2). ## `pets` (type: `integer`): Number of pets. ## `priceMin` (type: `integer`): Minimum nightly price in the chosen currency. ## `priceMax` (type: `integer`): Maximum nightly price in the chosen currency. ## `minBeds` (type: `integer`): Minimum number of beds. ## `minBedrooms` (type: `integer`): Minimum number of bedrooms. ## `minBathrooms` (type: `integer`): Minimum number of bathrooms. ## `propertyTypes` (type: `array`): Filter by Airbnb room type. Allowed values: "Entire home/apt", "Private room", "Shared room", "Hotel room". Unknown values are ignored. ## `currency` (type: `string`): Currency for all prices. ## `locale` (type: `string`): Language/locale for content. ## `skipDetailPages` (type: `boolean`): 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. ## `calendarMonths` (type: `integer`): Months of future availability + nightly price to fetch per listing (0 = none). Each month is one extra request per listing. ## `scrapeReviews` (type: `boolean`): 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. ## `maxReviewsPerListing` (type: `integer`): 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. ## `maxListings` (type: `integer`): 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). ## `priceSplitCeiling` (type: `integer`): 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. ## `enableMapSplit` (type: `boolean`): Recursively subdivide the map viewport into quadrants when price-band splitting still hits the cap. Useful for dense cities. ## `incrementalMode` (type: `boolean`): Track a market over time. First run captures a baseline; later runs emit only changes (new / price / availability / rating / delisted). Requires a Monitor key. ## `monitorKey` (type: `string`): 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` (type: `boolean`): Emit priceChanged records with old → new price and delta. ## `trackAvailabilityChanges` (type: `boolean`): Emit availabilityChanged records when a listing opens/closes for the monitored dates. ## `detectDelistings` (type: `boolean`): After scanning the whole market, emit delisted records for listings seen before but now absent. ## `proxyConfiguration` (type: `object`): 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. ## `maxConcurrency` (type: `integer`): Maximum parallel requests. Keep conservative (5–10) to avoid blocks. ## `maxRequestsPerMinute` (type: `integer`): Global request rate cap (throttling helps avoid 429s). ## `maxRequestRetries` (type: `integer`): Retries per request before a listing/search is classified and skipped (the run does not fail). ## Actor input object example ```json { "locationQueries": [ "Lisbon, Portugal" ], "adults": 1, "children": 0, "infants": 0, "pets": 0, "currency": "USD", "locale": "en", "skipDetailPages": false, "calendarMonths": 0, "scrapeReviews": true, "maxReviewsPerListing": 50, "maxListings": 100, "priceSplitCeiling": 0, "enableMapSplit": false, "incrementalMode": false, "trackPriceChanges": true, "trackAvailabilityChanges": true, "detectDelistings": true, "proxyConfiguration": { "useApifyProxy": true }, "maxConcurrency": 8, "maxRequestsPerMinute": 120, "maxRequestRetries": 5 } ``` # Actor output Schema ## `listings` (type: `string`): All scraped listings and the run-summary record. The Overview view shows key fields; switch to All fields for the complete record (amenities, photos, host data, reviews, etc.). # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "locationQueries": [ "Lisbon, Portugal" ], "adults": 1, "proxyConfiguration": { "useApifyProxy": true } }; // Run the Actor and wait for it to finish const run = await client.actor("scrapesage/airbnb-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "locationQueries": ["Lisbon, Portugal"], "adults": 1, "proxyConfiguration": { "useApifyProxy": True }, } # Run the Actor and wait for it to finish run = client.actor("scrapesage/airbnb-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "locationQueries": [ "Lisbon, Portugal" ], "adults": 1, "proxyConfiguration": { "useApifyProxy": true } }' | apify call scrapesage/airbnb-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=scrapesage/airbnb-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "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 } } } } } } } } } } ```