# Airbnb Image Downloader (`datascrapers/airbnb-images-downloader`) Actor

Provide an Airbnb listing URL, and this actor will download all the images, zip them, and give you a download link for the zipped file.

- **URL**: https://apify.com/datascrapers/airbnb-images-downloader.md
- **Developed by:** [Data Scrapers](https://apify.com/datascrapers) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.97 / 1,000 images

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

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

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
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.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## 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.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

**Airbnb Image Downloader** creates one dataset record for the photos on an Airbnb room URL. The record includes how many image URLs were found, how many JPEG files were saved, how many failed, and a `download_url` for a zip of the saved files in the run's key-value store. Query the source with one `airbnb_url`. The zip is also stored under the key `images.zip`. Retrieve the record through the Apify Dataset API, or export it as JSON, CSV, Excel, XML, or another supported format.

[![Airbnb Image Downloader — input to structured data](https://raw.githubusercontent.com/faizanalii/apify-actor-assets/main/airbnb-images-downloader/airbnb-images-downloader-value-demo.gif)](https://apify.com/datascrapers/airbnb-images-downloader)

### Dataset at a glance

| Property | Value |
|---|---|
| Source | Image URLs on one Airbnb room page |
| Record unit | One download result for that URL |
| Input methods | One Airbnb listing URL in `airbnb_url` |
| Main identifiers | None on the record. The room id is only in the input URL. |
| Delivery | Apify Dataset, plus `images.zip` in the key-value store |
| Export formats | JSON, CSV, Excel, XML, and other Apify dataset exports. The photos are a zip. |
| Update model | Fresh download per Actor run |
| Pricing | `image` at $3.00, $2.99, $2.98, and $2.97 per 1,000 saved images, plus platform usage. |

### Coverage and available records

The Actor requires `airbnb_url`. It takes the last path segment, before any query string, as the folder name. For `https://www.airbnb.com/rooms/782682596976136912` that segment is `782682596976136912`.

It collects the listing's image URLs, downloads each one as `{index}.jpg` in that order, and retries failures up to three times with one second between tries. It writes `images.zip` to the default key-value store with content type `application/zip`. The dataset item's `download_url` is:

`https://api.apify.com/v2/key-value-stores/{storeId}/records/images.zip`

`{storeId}` is the run's default key-value store id. The zip contains only the JPEG files that downloaded. File names are `0.jpg`, `1.jpg`, and so on, matching the image URL order. Failed indexes are omitted from the zip and listed in `failed_indices` when any remain.

The dataset item does not include the source URL, the image URLs, captions, or the photo bytes. This project has no saved dataset item from a completed run. The fields below are the keys `main.py` writes.

One run produces one dataset item, even when the listing has many photos. There is no `maxItems` input and no second listing in the same run.

### Data dictionary

| Field | Type | Nullable | Description | Example |
|---|---|---:|---|---|
| `download_url` | string | No | API URL of `images.zip` in this run's key-value store. | `.../records/images.zip` |
| `total_images` | integer | No | Count of image URLs found on the listing. | Set by the run |
| `downloaded_images` | integer | No | Count of JPEG files written into the zip. | Set by the run |
| `failed_images` | integer | No | Count of image URLs that still failed after retries. | Set by the run |
| `failed_indices` | array of integers | Conditional | Original indexes that failed. Omitted when every download succeeds. | Present only on failure |

The zip entry `images.zip` is not a dataset field. Open `download_url` to retrieve it. Deduplicate outside the dataset with the room id from `airbnb_url`. The Actor does not write that id onto the record.

### Example dataset record

No captured dataset item is stored in this project. The object below is the shape `main.py` writes after a run in which every download succeeds. Replace `{storeId}` with the run's key-value store id. The integers are produced by that run and are not taken from a saved sample.

```json
{
  "download_url": "https://api.apify.com/v2/key-value-stores/{storeId}/records/images.zip",
  "total_images": 0,
  "downloaded_images": 0,
  "failed_images": 0
}
```

`total_images`, `downloaded_images`, and `failed_images` are integers in a real run. They are shown as `0` here only because this folder has no saved item. Do not treat `0` as a measured count. When downloads fail, the same object also includes `failed_indices`, an array of integers.

### Query and input reference

| Input | Type | Required | Default | Accepted values | Description |
|---|---|---:|---|---|---|
| `airbnb_url` | string | Yes | `https://www.airbnb.com/rooms/782682596976136912` | One Airbnb listing URL | Page whose images are downloaded. |
| `proxyConfiguration` | object | No | Apify residential | Apify proxy input | Connection used for the listing and image requests. |

```json
{
  "airbnb_url": "https://www.airbnb.com/rooms/782682596976136912",
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": ["RESIDENTIAL"]
  }
}
```

An empty `airbnb_url` stops the run before any download.

### Retrieve the data through the API

This is the Apify Actor API. Airbnb does not provide this endpoint.

1. Start `datascrapers/airbnb-images-downloader` with a JSON input.
2. Wait until the run finishes, or poll the run status.
3. Read the single item from the run's default dataset.
4. Download the zip from `download_url`, or from the key-value store key `images.zip`.

```python
from apify_client import ApifyClient

client = ApifyClient("YOUR_API_TOKEN")
run = client.actor("datascrapers/airbnb-images-downloader").call(run_input={
    "airbnb_url": "https://www.airbnb.com/rooms/782682596976136912",
})
items = client.dataset(run["defaultDatasetId"]).list_items().items
print(items[0]["download_url"])
```

Other languages are listed on the Actor's API tab in Apify Console. Do not put a real token in a URL or in source control.

### Export and pipeline examples

| Destination | Recommended method | Typical use |
|---|---|---|
| Object storage | HTTP GET of `download_url` | Keep the zip of JPEG files |
| PostgreSQL or Supabase | Dataset API | Store the input room id with the four count fields |
| Google Sheets | Apify integration | Track download success counts |
| A custom application | Key-value store record `images.zip` | Unzip `0.jpg`, `1.jpg`, and the rest in URL order |

### Data quality and record handling

Image URLs come from the listing page. Files are downloaded in that order and named by index. Each failed URL is retried up to three times. Indexes that still fail are excluded from the zip, counted in `failed_images`, and listed in `failed_indices`. A run can finish with a zip that contains fewer files than `total_images`.

`downloaded_images` plus `failed_images` equals `total_images` when the counts are consistent with that logic. The source URL is not written to the dataset. The folder name on disk during the run is the listing id path segment, but that name is not a dataset field.

There is no saved sample in this project, so this page does not claim a photo count for the default URL. The default input value is `https://www.airbnb.com/rooms/782682596976136912`.

### Pricing and cost examples

Each JPEG saved into the zip is one `image` event. The dataset is still one row plus `images.zip`. Prices per 1,000 images are $3.00, $2.99, $2.98, and $2.97 across the plans, which is $0.003, $0.00299, $0.00298, and $0.00297 per image. The two highest plans use $2.97 per 1,000. A run that saves 44 images on the first plan is 44 × $0.003 = $0.132. Images that fail to download are not charged. Compute time and download traffic are platform usage on top of that.

### Limitations and responsible data use

The Actor downloads images linked from one public Airbnb listing URL and packs the successful files into a zip. It does not return captions, room labels, or a historical archive. A later run can see a different photo set.

Failed files are absent from the zip. The dataset row does not repeat the source URL. Image files are the listing's photos. You are responsible for using them in line with Airbnb terms, copyright, privacy rules, and any contract that applies to your project. This page does not provide a legal conclusion about a particular use.

### Dataset questions

#### What does one dataset item represent?

One download result for one `airbnb_url`: counts plus the zip URL. The photos are the zip, not extra dataset rows.

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

The record has no listing id. Use the room id from `airbnb_url` outside the dataset. `download_url` changes with every run because the key-value store id changes.

#### Are fields nullable or conditional?

`failed_indices` is omitted when every image downloads. The other four fields are written on every saved item. This page has no captured item, so it does not show a live null.

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

Yes for the count record. Download JSON, CSV, Excel, XML, or another format from the Apify Console export menu. The photos are the zip at `download_url`, not columns in the CSV.

#### How do I paginate large datasets?

A run writes one dataset item. Page the zip internally by JPEG file name. The Actor does not accept a list of listings.

#### Does the Actor return historical data?

No. The zip is the images found during that run.

#### What counts as a billable result?

Each saved JPEG is one `image` event. A failed download is not charged. The dataset row itself is not a separate event. Image download traffic is platform usage.

### Related datasets from Data Scrapers

- [Airbnb Address Finder](https://apify.com/datascrapers/airbnb-address-finder) — listing fields and a geocoded place name for a room URL.
- [Airbnb Scraper](https://apify.com/datascrapers/airbnb-scraper) — search and listing records that include photo URLs without packaging a zip.
- [Airbnb Detailed Scraper](https://apify.com/datascrapers/airbnb-detailed-scraper) — detailed listing records for the same room id.
- [Airbnb Availability Calendar Scraper](https://apify.com/datascrapers/airbnb-availability-calendar) — nightly availability for a room URL.
- [Booking.com Scraper](https://apify.com/datascrapers/booking-com-scraper) — stay records for a related travel dataset.

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

## `airbnb_url` (type: `string`):

URL of the Airbnb listing from which to download images

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

Select proxy groups or use your custom proxies

## Actor input object example

```json
{
  "airbnb_url": "https://www.airbnb.com/rooms/12345678",
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}
```

# Actor output Schema

## `results` (type: `string`):

JSON array with one download record at {{links.apiDefaultDatasetUrl}}/items

## `imagesZip` (type: `string`):

Zip of the JPEG files saved from the listing

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

Record count and timestamps for this run

## `run` (type: `string`):

Public console page 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 = {
    "proxyConfiguration": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ]
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("datascrapers/airbnb-images-downloader").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 = { "proxyConfiguration": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
    } }

# Run the Actor and wait for it to finish
run = client.actor("datascrapers/airbnb-images-downloader").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 '{
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}' |
apify call datascrapers/airbnb-images-downloader --silent --output-dataset

```

## MCP server setup

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

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/BmahHNHgkAHTeikTX/builds/7tsK3fgTsjE2GqFp7/openapi.json
