> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Airbnb Listing Search

Structured Airbnb data: send `query`. Cursor-paginated, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/airbnb-listings/` · 1 credit per successful call · Cursor-paginated

## Overview

Call `GET /api/v2/airbnb-listings/` with `query`. The results are in `data.listings`; send `data.next_cursor` back as `cursor` to get the next page. 5 optional parameters refine the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/airbnb-listings/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "query=London" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/airbnb-listings/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"query": "London"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["listings"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `query` | string | yes | e.g. `London` | Location to search (city, neighborhood, etc.). Required on first call; ignored when `cursor` is supplied. |
| `cursor` | string | no | — | Pagination cursor returned in the previous response's `next_cursor`. Pass it back unchanged to fetch the next page. When `next_cursor` is null, you have reached the last page. |
| `checkin` | string | no | `2026-12-01` | Check-in date (YYYY-MM-DD). Locked into the cursor on first call. |
| `checkout` | string | no | `2026-12-08` | Check-out date (YYYY-MM-DD). Locked into the cursor on first call. |
| `currency` | string | no | `USD` | Currency code (USD, EUR, GBP, ...). Locked into the cursor. |
| `locale` | string | no | `en-US` | Locale (en-US, fr-FR, ...). Locked into the cursor. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `false` | When true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under `raw_responses`, in place of the formatted items. When false (default) you get the formatted output. Pagination (`cursor` / `next_cursor`) works the same in both modes. |

## Response

HTTP 200. Results are in `data.listings`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "query": "London",
    "checkin": "2026-01-01",
    "checkout": "2026-01-08",
    "currency": "USD",
    "locale": "en-US",
    "page_size": 18,
    "listings": [
      {
        "id": "569049214818933247",
        "title": "Stunning Loft in Downtown London",
        "url": "https://www.airbnb.com/rooms/569049214818933247",
        "thumbnail": "https://a0.muscache.com/im/pictures/miso/xxx.jpg",
        "description": "Beautiful loft with panoramic views...",
        "currency": "USD",
        "locale": "en-US",
        "rating_accuracy": 4.9,
        "rating_checking": 5,
        "rating_cleanliness": 4.8,
        "rating_communication": 4.9,
        "rating_location": 4.9,
        "rating_value": 4.7,
        "rating_guest_satisfaction": 4.85,
        "rating_reviews_count": 127,
        "price_amount": "$1,015",
        "price_label": "$1,015 for 7 nights",
        "price_qualifier": "for 7 nights",
        "latitude": 51.5074,
        "longitude": -0.1278,
        "keyword": "London",
        "position": 1
      }
    ],
    "next_cursor": "zc1.eNoBVQGq_gAAAEt7InEiOiJMb25kb24i..."
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `query` | string | `London` |  |
| `checkin` | string | `2026-01-01` |  |
| `checkout` | string | `2026-01-08` |  |
| `currency` | string | `USD` |  |
| `locale` | string | `en-US` |  |
| `page_size` | integer | `18` |  |
| `listings` | array | `[1 item]` | The results. |
| `next_cursor` | string | `zc1.eNoBVQGq_gAAAEt7InEiOiJMb25kb24i...` | Pass back as `cursor` for the next page. `null` on the last page. |
| `listings[].id` | string | `569049214818933247` |  |
| `listings[].title` | string | `Stunning Loft in Downtown London` |  |
| `listings[].url` | string | `https://www.airbnb.com/rooms/569049214818933247` |  |
| `listings[].thumbnail` | string | `https://a0.muscache.com/im/pictures/miso/xxx.jpg` |  |
| `listings[].description` | string | `Beautiful loft with panoramic views...` |  |
| `listings[].currency` | string | `USD` |  |
| `listings[].locale` | string | `en-US` |  |
| `listings[].rating_accuracy` | number | `4.9` |  |
| `listings[].rating_checking` | integer | `5` |  |
| `listings[].rating_cleanliness` | number | `4.8` |  |
| `listings[].rating_communication` | number | `4.9` |  |
| `listings[].rating_location` | number | `4.9` |  |
| `listings[].rating_value` | number | `4.7` |  |
| `listings[].rating_guest_satisfaction` | number | `4.85` |  |
| `listings[].rating_reviews_count` | integer | `127` |  |
| `listings[].price_amount` | string | `$1,015` |  |
| `listings[].price_label` | string | `$1,015 for 7 nights` |  |
| `listings[].price_qualifier` | string | `for 7 nights` |  |
| `listings[].latitude` | number | `51.5074` |  |
| `listings[].longitude` | number | `-0.1278` |  |
| `listings[].keyword` | string | `London` |  |
| `listings[].position` | integer | `1` |  |

## Pagination

Pass `data.next_cursor` back as `cursor` until it is `null`. Required inputs are ignored once a cursor is sent. Each page is one billed call.

```python
import requests

URL = "https://api.scrapier.io/api/v2/airbnb-listings/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"query": "London"}
items = []

for _ in range(10):  # each page is one billed call
    resp = requests.get(URL, headers=HEADERS, params=params, timeout=210)
    resp.raise_for_status()
    data = resp.json()["data"]
    items.extend(data.get("listings") or [])
    if not data.get("next_cursor"):  # None = last page
        break
    params = {"cursor": data["next_cursor"]}
```

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- Nothing special: send the inputs, read the result.

## Related

- [Airbnb Occupancy / Availability](https://docs.scrapier.io/api-reference/airbnb/airbnb-occupancy.md): Structured Airbnb data: send `room_id`. Cursor-paginated, 1 credit per successful call.
- [Airbnb Price Tracker](https://docs.scrapier.io/api-reference/airbnb/airbnb-price-tracker.md): Structured Airbnb data: send `url`. Cursor-paginated, 1 credit per successful call.
- [Airbnb Reviews Scraper](https://docs.scrapier.io/api-reference/airbnb/airbnb-reviews.md): Structured Airbnb data: send `url`. Cursor-paginated, 1 credit per successful call.
- [Airbnb Room URL Scraper](https://docs.scrapier.io/api-reference/airbnb/airbnb-room-urls.md): Structured Airbnb data: send `url`. Cursor-paginated, 1 credit per successful call.
