# Airbnb Scraper (`caprolok/airbnb-scraper`) Actor

The Airbnb Scraper collects comprehensive data from Airbnb, including listings, prices, host details, reviews, and availability. Perfect for market research, competitive analysis, or investment insights, it delivers real-time, structured information to streamline decision-making.

- **URL**: https://apify.com/caprolok/airbnb-scraper.md
- **Developed by:** [Caprolok](https://apify.com/caprolok) (community)
- **Categories:** Lead generation, SEO tools, Travel
- **Stats:** 91 total users, 1 monthly users, 100.0% runs succeeded, 1 bookmarks
- **User rating**: 1.00 out of 5 stars

## Pricing

$15.00/month + usage

To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period. You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#rental-actors

## 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 Co Scraper

The **Airbnb Co Scraper** allows you to extract detailed Airbnb listing information—such as prices, reviews, amenities, descriptions, and more—across multiple locations, dates, and custom settings. Whether you’re a traveler, real estate analyst, or Airbnb host conducting market research, the scraper efficiently gathers extensive Airbnb data for your needs.

***

### 🚀 Features

- **Detailed data extraction:** Gathers a wide range of information (title, price, location, images, host details, descriptions, amenities, policies, etc.).
- **Flexible search options:** Choose check-in/check-out dates, keywords (locations), and maximum results.
- **Optional detailed view:** Set `fetchDetails` to `true` to retrieve more in-depth listing details (host bio, property policies, etc.).
- **Pagination support:** Automatically handles multiple pages of results to reach your desired max results.
- **Configurable proxy usage:** Easily integrate with Apify Proxy to ensure reliable data collection.
- **Scalability:** Scrape anywhere from a handful of listings to thousands, based on your specified limit.

***

### 🔍 Scraped Data

Below are some of the fields typically extracted by the scraper. Actual data fields may vary depending on whether `fetchDetails` is enabled and the specific listing availability:

- **id:** Unique identifier of the Airbnb listing.
- **title:** Main title of the listing.
- **price:** Nightly or base price.
- **thumbnailUrl:** Primary photo or thumbnail for the listing.
- **latitude, longitude:** Geographic coordinates of the listing.
- **roomType:** Type of listing (entire home, private room, shared room, etc.).
- **hostName / hostProfilePicture / isSuperhost:** Host details, including name, photo, and superhost status.
- **ratings & reviews:** Aggregate rating, number of reviews, or breakdown (where available).
- **detailTitle & detailDescription:** Additional, detailed listing titles and extended descriptions.
- **images:** Array of images, each with an ID, URL, and optional caption.
- **amenities:** List of amenities or features offered.
- **policies:** House rules, check-in/check-out times, and safety/property info.
- **cancellationPolicy:** The cancellation policy type and related details.

***

#### Sample Input

```json
{
  "checkin_date": "2025-01-23",
  "checkout_date": "2025-01-24",
  "fetchDetails": true,
  "keywords": [
    "Chicago, Illinois, United States"
  ],
  "max_results": 10,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ],
    "apifyProxyCountry": "US"
  }
}
```

***

### 📊 Output Format

When the scraper finishes, it returns an array of listings, each containing relevant fields. Below is a **simplified** sample structure (not actual data).

```json
v[
  {
    "id": "123456",
    "title": "Modern Downtown Loft",
    "price": "$220 per night",
    "thumbnailUrl": "https://example.com/thumbnail.jpg",
    "latitude": 41.12345,
    "longitude": -87.65432,
    "roomType": "entire_home",
    "ratingCount": "45",
    "ratingAverage": "4.8",
    "yearsHosting": "2",
    "hostName": "John Doe",
    "hostProfilePicture": "https://example.com/host.jpg",
    "isSuperhost": true,
    "detailTitle": "Spacious, Light-Filled Loft Near All Amenities",
    "detailDescription": "Enjoy the best of the city in this bright, airy loft...",
    "images": [
      {
        "id": "001",
        "url": "https://example.com/image1.jpg",
        "caption": "Living room area"
      },
      {
        "id": "002",
        "url": "https://example.com/image2.jpg",
        "caption": "Kitchen space"
      }
    ],
    "amenities": "WiFi, Air conditioning, Kitchen, Elevator, Heating",
    "policies": {
      "title": "Things to know",
      "houseRules": [
        "No smoking",
        "Check-in after 3:00 pm",
        "Checkout before 11:00 am"
      ],
      "safetyAndPropertyInfo": [
        "Smoke alarm",
        "Carbon monoxide alarm"
      ]
    },
    "cancellationPolicy": [
      {
        "policyName": "Moderate",
        "tooltip": "Add your trip dates to get the cancellation details...",
        "link": "/help/article/2637",
        "linkText": "Get full details"
      }
    ],
    "sharingConfigCapacity": 4,
    "sharingConfigRating": 4.8,
    "sharingConfigreviewCount": 45
  },
  {
    "id": "789012",
    "title": "Charming Vintage Suite",
    "price": "$120 per night",
    "thumbnailUrl": "https://example.com/vintage-suite.jpg",
    "...": "Other relevant fields"
  }
]
```

***

### 📋 Input Parameters

Below are the parameters you can provide to customize the scraper’s behavior:

Field                | Description                                                  | Example Input
\---------------------|--------------------------------------------------------------|---------------
**checkin\_date**     | Specify the check-in date (YYYY-MM-DD)                       | `"2025-01-23"`
**checkout\_date**    | Specify the check-out date (YYYY-MM-DD)                      | `"2025-01-24"`
**fetchDetails**     | Boolean to fetch more comprehensive details per listing      | `true`
**keywords**         | Array of location keywords                                   | `["Chicago, Illinois, United States"]`
**max\_results**      | Maximum number of Airbnb listings to scrape                  | `10`
**proxyConfiguration** | Proxy settings including Apify Proxy usage                 | See example below

***

### ⚡ Performance

- **Speed:** Quickly retrieves up to `max_results` listings (or more if you configure further).
- **Scalability:** Adequate for small or large data requests.
- **Efficiency:** Minimizes redundant calls, making the best use of pagination and concurrency.

***

### 🛠️ Customizable Scraping Options

1. **Dates**: Customize check-in/check-out.
2. **Keywords (Location)**: Provide a list of places or neighborhoods.
3. **Maximum Listings**: Limit how many listings you want.
4. **Fetch Details**: Toggle deep-level details (like host info, policies, etc.).
5. **Proxy Usage**: Use Apify Proxy or custom proxy settings to handle requests reliably.

***

### 📊 Use Cases

- **Travel Planning:** Compare rental prices, read host reviews, and see amenities at different locations.
- **Market Research:** Real estate professionals can analyze listing supply, average prices, and more.
- **Competitor Analysis:** Airbnb hosts can see how their competitors perform in a specific region.
- **Investment Decision:** Potential investors can gauge property performance, location popularity, and pricing strategies.

***

### 🆘 Support

For issues, feature requests, or feedback, please open an issue in our repository. We aim to respond quickly and ensure the scraper works smoothly for everyone.

***

**Happy Scraping!**

# Actor input Schema

## `keywords` (type: `array`):

Insert the location of valid Airbnb search pages.

## `checkin_date` (type: `string`):

Specify the check-in date (YYYY-MM-DD).

## `checkout_date` (type: `string`):

Specify the check-out date (YYYY-MM-DD).

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

Select proxies to be used by your scraper.

## `fetchDetails` (type: `boolean`):

Enable this toggle to fetch detailed information for each listing.

## `max_results` (type: `integer`):

Specify the maximum number of hotel listings to scrape.

## Actor input object example

```json
{
  "keywords": [
    "Chicago, Illinois, United States"
  ],
  "checkin_date": "2024-09-23",
  "checkout_date": "2024-09-24",
  "proxyConfiguration": {
    "useApifyProxy": true
  },
  "fetchDetails": true,
  "max_results": 50
}
```

# 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 = {
    "keywords": [
        "Chicago, Illinois, United States"
    ],
    "proxyConfiguration": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("caprolok/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 = {
    "keywords": ["Chicago, Illinois, United States"],
    "proxyConfiguration": { "useApifyProxy": True },
}

# Run the Actor and wait for it to finish
run = client.actor("caprolok/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 '{
  "keywords": [
    "Chicago, Illinois, United States"
  ],
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}' |
apify call caprolok/airbnb-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,caprolok/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/Qwp5FScQUE9M0WjpW/builds/Ox6f8yFSnYVoWdCVk/openapi.json