# Airbnb Scraper - Search & Listing Details (`datascrapers/airbnb-scraper`) Actor

Search Airbnb by location and extract listing details, host info, reviews, photos, and optional availability calendars.

- **URL**: https://apify.com/datascrapers/airbnb-scraper.md
- **Developed by:** [Farhan Ali](https://apify.com/datascrapers) (community)
- **Categories:** Real estate, Travel, Integrations
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.20 / 1,000 listings

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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 - Search & Listing Details** creates a structured dataset of short-term rental listings collected from [Airbnb](https://www.airbnb.com). Each dataset item represents one listing and can include pricing, amenities, host information, ratings and reviews, images, bedroom and bathroom details, and location data. Query the source using one or more location search terms, optionally enable listing details, host info, calendar, and reviews, control the result limit with `maxItems`, and retrieve records through the Apify Dataset API or export them as JSON, CSV, Excel, XML, or HTML.

### Dataset at a glance

| Property | Value |
|---|---|
| Source | airbnb.com (public listing pages) |
| Record unit | One short-term rental listing |
| Input methods | Location search queries (`searchQueries`) |
| Main identifiers | `identifier` (Airbnb listing ID), `url` |
| Delivery | Apify Dataset and API |
| Export formats | JSON, CSV, Excel, XML, HTML |
| Update model | Fresh records per Actor run |
| Pricing | $5 per 1,000 listings (plus optional enrichments) |

### Coverage and available records

The Actor discovers listings by location search query and collects a record for each listing it finds.

- **Search-based discovery**: Pass one or more location queries such as `newyork`, `paris`, or `tokyo apartment`. Each query is resolved into matching listings automatically; no manual URL collection is needed.
- **Result limits**: `maxItems` caps the total number of listings collected (`0` = unlimited). `maxPages` caps how many search result pages are scanned (`0` = unlimited).
- **Optional enrichments** (each enabled independently):
  - `listingDetails` — full listing details (name, description, photos, amenities, location, ratings).
  - `hostInfo` — host profile (name, photo, superhost status, stats).
  - `listingCalendar` — a 12-month availability calendar.
  - `listingReviews` — guest reviews, capped per listing by `maxReviews` (default 10).
- **Record types**: The base record carries listing identifiers, headline, description, images, location, and the supplement (policy) fields. Detail, host, calendar, and review fields appear only when their toggle is enabled.

Known exclusions: content Airbnb shows only behind login is not collected; each run captures page state at run time (no historical snapshots); exact addresses are only returned when the listing exposes them.

### Data dictionary

Field names below match dataset record JSON properties exactly.

| Field | Type | Nullable | Description | Example |
|---|---:|---|---|---|
| `identifier` | string | No | Airbnb listing ID; best stable deduplication key | `1234567890123456789` |
| `url` | string | No | Canonical listing URL | `https://www.airbnb.com/rooms/1234567890123456789` |
| `active` | boolean | Yes | Whether the listing is currently active | `true` |
| `name` | string | Yes | Listing title | `Cozy Studio in Midtown East` |
| `headline` | string | Yes | Listing headline | `Stunning Manhattan studio with skyline views` |
| `description` | string | Yes | Full property description | Long-form listing copy |
| `story` | string | Yes | Host-provided story text | Long-form host copy |
| `unit` | object | Yes | Property type info: `{name, category, active}` | See example record |
| `images` | array | Yes | Photo objects: `{identifier, url, title}` | See example record |
| `location` | object | Yes | `{address, coordinates, show_exact}` | See example record |
| `host` | object | Yes | `{host, superhost, verified, stats}` (conditional — `hostInfo`) | See example record |
| `rating` | object | Yes | `{total_reviews, overall_rating, ratings}` | See example record |
| `features` | array | Yes | Amenity objects: `{name, description}` | `[{ "name": "Wifi" }]` |
| `safety_features` | array | Yes | Safety equipment objects: `{name, note}` | `[{ "name": "Smoke alarm" }]` |
| `bathrooms` | array | Yes | Bathroom objects: `{name, category, amenities}` | See example record |
| `bedrooms` | array | Yes | Bedroom objects: `{name, category, amenities}` | See example record |
| `supplement` | object | Yes | `{max_guests, allows_children, allows_pets, allows_events, cancellation_policy}` | See example record |
| `calendar` | array | Yes | 12-month availability (conditional — `listingCalendar`) | See example record |
| `reviews` | array | Yes | Guest reviews (conditional — `listingReviews`) | See example record |
| `sourceQuery` | string | Yes | Search query that produced the listing | `newyork` |

### Example dataset record

A representative record produced by a search for `newyork` with `listingDetails`, `hostInfo`, `listingCalendar`, and `listingReviews` enabled:

```json
{
  "identifier": "1234567890123456789",
  "url": "https://www.airbnb.com/rooms/1234567890123456789",
  "active": true,
  "name": "Cozy Studio in Midtown East",
  "headline": "Stunning Manhattan studio with skyline views",
  "description": "Modern studio apartment in the heart of Manhattan...",
  "unit": {
    "name": "Cozy Studio in Midtown East",
    "category": "PROPERTY_TYPE_APARTMENT",
    "active": true
  },
  "images": [
    { "identifier": "123...", "url": "https://a0.muscache.com/...", "title": "" }
  ],
  "location": {
    "address": { "city": "New York", "subdivision": "NY", "country": "United States" },
    "coordinates": { "lat": "40.7531", "lng": "-73.9822" },
    "show_exact": true
  },
  "host": {
    "host": { "name": "Jane", "profilePictureUrl": "https://..." },
    "superhost": true,
    "verified": true,
    "stats": [
      { "label": "Response rate", "value": "100%", "type": "percentage" }
    ]
  },
  "rating": {
    "total_reviews": 142,
    "overall_rating": 4.85,
    "ratings": [
      { "categoryType": "cleanliness", "label": "Cleanliness", "percentage": 95 }
    ]
  },
  "supplement": {
    "max_guests": 3,
    "allows_children": false,
    "allows_pets": false,
    "allows_events": true,
    "cancellation_policy": "MODERATE"
  },
  "features": [ { "name": "Wifi", "description": "" }, { "name": "Kitchen", "description": "" } ],
  "safety_features": [ { "name": "Smoke alarm", "note": "" } ],
  "bathrooms": [ { "name": "Bathroom 1", "category": "FULL_BATH", "amenities": [] } ],
  "bedrooms": [ { "name": "Bedroom 1", "category": "BEDROOM", "amenities": [] } ],
  "sourceQuery": "newyork"
}
```

The record above was produced with input `{"searchQueries": ["newyork"], "maxItems": 2}` plus the enrichment toggles enabled.

### Query and input reference

| Input | Type | Required | Default | Accepted values | Description |
|---|---|---|---|---|---|
| `searchQueries` | array\[string] | Yes | — | Free text (e.g. `newyork`, `paris`) | Location or search queries used to discover listings |
| `maxItems` | integer | No | `0` | `0` or a positive integer | Maximum listings to collect; `0` = unlimited. Takes precedence over `maxListings` |
| `maxListings` | integer | No | `0` | `0` or a positive integer | Legacy alias for `maxItems`, used only when `maxItems` is omitted |
| `maxPages` | integer | No | `0` | `0` or a positive integer | Maximum search result pages per query; `0` = unlimited |
| `listingDetails` | boolean | No | `false` | `true` / `false` | Extract full listing details (charged as `listing-details`) |
| `hostInfo` | boolean | No | `false` | `true` / `false` | Extract host profile (charged as `host-info`) |
| `listingCalendar` | boolean | No | `false` | `true` / `false` | Extract 12-month availability (charged as `listing-calendar`) |
| `listingReviews` | boolean | No | `false` | `true` / `false` | Extract guest reviews (charged as `listing-reviews`) |
| `maxReviews` | integer | No | `10` | `0` or a positive integer | Maximum reviews per listing when `listingReviews` is enabled; `0` = unlimited |
| `scrapeCalendar` | boolean | No | `false` | `true` / `false` | Legacy alias for `listingCalendar` |
| `proxyConfiguration` | object | No | Apify residential proxy | Apify proxy groups or custom proxies | Residential proxies are recommended |

Minimal request:

```json
{ "searchQueries": ["newyork"] }
```

Enriched request:

```json
{
  "searchQueries": ["newyork", "paris"],
  "maxItems": 100,
  "maxPages": 5,
  "listingDetails": true,
  "hostInfo": true,
  "listingCalendar": true,
  "listingReviews": true,
  "maxReviews": 10,
  "proxyConfiguration": { "useApifyProxy": true, "apifyProxyGroups": ["RESIDENTIAL"] }
}
```

### Retrieve the data through the API

1. Start the Actor with a JSON input (console or API).
2. Wait for the run to finish, or use a synchronous endpoint for an inline response.
3. Retrieve items from the run's default dataset.
4. Paginate or export the dataset.

Python example:

```python
from apify_client import ApifyClient

client = ApifyClient("YOUR-APIFY-TOKEN")

run = client.actor("datascrapers/airbnb-scraper").call(run_input={
    "searchQueries": ["newyork"],
    "maxItems": 50,
    "listingDetails": True,
})
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item["identifier"], item["name"])
```

Apify generates ready-to-run Python, JavaScript, and cURL examples on the Actor's API tab. Do not put a real API token in shared code or URLs.

### Data quality and record handling

- **Conditional fields**: Detail, host, calendar, and review fields are present only when their input toggle is enabled. Values a listing does not publish are returned as null or empty arrays rather than fabricated.
- **Source changes**: Airbnb page structure and values can change; unreadable fields are returned as null.
- **Deduplication**: Each run appends fresh records; the Actor does not deduplicate across runs. Use `identifier` as the stable key and filter repeated runs against previously stored IDs.
- **Rate limits**: Airbnb rate-limits automated traffic. Residential proxies (enabled by default) are recommended for consistent coverage.
- **Normalization**: Values are read from the listing and normalized to the field types in the data dictionary.

### Export and pipeline examples

| Destination | Recommended method | Typical use |
|---|---|---|
| PostgreSQL / Supabase | Dataset API poll or webhook consumer | Store listing snapshots alongside pricing research |
| Google Sheets | Apify Google Sheets integration | Share shortlists with analysts |
| S3 / cloud storage | Scheduled export via Apify scheduler | Archival of market snapshots |
| BI tools | CSV / JSON export | Supply, demand, and pricing trend analysis |

### Pricing and cost examples

The Actor uses pay-per-event pricing. The primary charge event is the listing result:

| Event | Trigger | Rate |
|---|---|---|
| Listing | Every listing pushed to the dataset | $5 per 1,000 listings |

A one-time Actor start event of $0.00005 applies to each run (effectively $0). Enabling an enrichment adds a corresponding charge event — `listing-details`, `host-info`, `listing-calendar`, or `listing-reviews` — billed separately when its toggle is on. Check the Actor's pricing tab for the current per-event rates.

| Listings (base record only) | Estimated base cost |
|---:|---:|
| 1,000 | $5.00 |
| 10,000 | $50.00 |
| 100,000 | $500.00 |

Compute units consumed by the run are billed by your Apify plan. Estimates depend on the verified pricing model and the options selected for the run.

### Limitations and responsible data use

- The Actor collects publicly accessible listing data from Airbnb only.
- Field availability depends on what Airbnb renders at run time; some values can be null or missing, and site changes can alter fields.
- The Actor does not provide historical snapshots unless you store them yourself.
- Large runs require residential proxies; without them, coverage may degrade due to rate limiting.
- You are responsible for compliance with Airbnb's terms of service, applicable privacy law, and any contractual obligations before using the data.

### Dataset questions

#### What does one dataset item represent?

One Airbnb listing. All detail fields (images, host, rating, rooms, calendar, reviews) are nested inside that single listing record.

#### Which field should I use as a unique identifier?

`identifier` is the stable Airbnb listing ID and the recommended deduplication key. `url` is a reasonable secondary key.

#### Are fields nullable or conditional?

Yes. Detail, host, calendar, and review fields exist only when their toggle is enabled. Fields Airbnb does not publish for a given listing are returned as null or empty.

#### Can I retrieve the records as CSV or JSON?

Yes. The dataset can be exported as JSON, CSV, Excel, XML, or HTML from the Apify Console, and queried through the Dataset API.

#### Does the Actor return historical data?

No. Each run captures the state of the pages at run time. To track changes, schedule repeated runs and store the outputs yourself.

#### What counts as a billable result?

Each listing record is one billable result, charged at $5 per 1,000 listings. Optional enrichments add separate charge events when enabled. Use `maxItems`, `maxPages`, and `maxReviews` to control cost per run.

### Related datasets from Data Scrapers

- **[Apartments.com Scraper](https://apify.com/datascrapers/apartments-scraper)** — Long-term rental listings that complement short-term rental data for housing-market analysis.
- **[Redfin Scraper](https://apify.com/datascrapers/redfin-scraper)** — For-sale residential listings with pricing and property details for market research.
- **[Rightmove Scraper](https://apify.com/datascrapers/rightmove-co-uk-scraper)** — UK property listings for cross-market comparison.
- **[Zoopla Scraper](https://apify.com/datascrapers/zoopla-scraper)** — Additional UK property listings for price and availability tracking.

### Data Scrapers support

Need an additional field, record type, or export workflow? Contact Data Scrapers at stardustspotlight@gmail.com. Include a sample source URL, required fields, expected record volume, and preferred delivery format.

# Actor input Schema

## `searchQueries` (type: `array`):

Locations or search terms to scrape Airbnb listings from (e.g. "newyork", "paris", "tokyo").

## `maxItems` (type: `integer`):

Maximum number of listings to scrape (0 = unlimited). Takes precedence over maxListings when both are set.

## `maxListings` (type: `integer`):

Legacy alias for maxItems. Used only when maxItems is omitted.

## `maxPages` (type: `integer`):

Maximum number of search result pages to scan per query (0 = unlimited).

## `listingDetails` (type: `boolean`):

Extract full listing details (name, description, photos, amenities, location, ratings). Charged as listing-details.

## `hostInfo` (type: `boolean`):

Extract host profile (name, photo, superhost, stats). Charged as host-info.

## `listingCalendar` (type: `boolean`):

Extract a 12-month availability calendar. Charged as listing-calendar. scrapeCalendar is accepted as a legacy alias.

## `listingReviews` (type: `boolean`):

Extract guest reviews for each listing. Charged as listing-reviews.

## `maxReviews` (type: `integer`):

Maximum number of reviews to extract per listing when listingReviews is enabled (0 = unlimited).

## `scrapeCalendar` (type: `boolean`):

Legacy alias for listingCalendar.

## `proxyConfiguration` (type: `object`):

Proxy settings for anti-bot protection. Apify Residential proxies recommended.

## Actor input object example

```json
{
  "searchQueries": [
    "newyork"
  ],
  "maxItems": 50,
  "maxListings": 0,
  "maxPages": 0,
  "listingDetails": false,
  "hostInfo": false,
  "listingCalendar": false,
  "listingReviews": false,
  "maxReviews": 10,
  "scrapeCalendar": false,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}
```

# Actor output Schema

## `dataset` (type: `string`):

Default dataset containing scraped Airbnb listings

## `runStats` (type: `string`):

Record count and timestamps for this run

# 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "searchQueries": [
        "newyork"
    ],
    "maxItems": 50,
    "maxReviews": 10,
    "proxyConfiguration": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ]
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("datascrapers/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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "searchQueries": ["newyork"],
    "maxItems": 50,
    "maxReviews": 10,
    "proxyConfiguration": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
    },
}

# Run the Actor and wait for it to finish
run = client.actor("datascrapers/airbnb-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "searchQueries": [
    "newyork"
  ],
  "maxItems": 50,
  "maxReviews": 10,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}' |
apify call datascrapers/airbnb-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,datascrapers/airbnb-scraper"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/snufNsAkFMVbA39OD/builds/XwU13RrNBQ5iwfzCf/openapi.json