> 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 Room URL Scraper

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

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

## Overview

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

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/airbnb-room-urls/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "url=https://www.airbnb.com/rooms/668146487515150072" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/airbnb-room-urls/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"url": "https://www.airbnb.com/rooms/668146487515150072"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

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

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. |
| `url` | string | yes | e.g. `https://www.airbnb.com/rooms/668146487515150072` | Airbnb listing URL. Returns full structured detail. This is a lookup endpoint — `next_cursor` is always null. |
| `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. |
| `currency` | string | no | `USD` | Currency code |
| `locale` | string | no | `en-US` | Locale |
| `adults` | integer | no | `2` | Adults |
| `children` | integer | no | `0` | Children |
| `pets` | integer | no | `0` | Pets |
| `check_in` | string | no | — | Check-in (YYYY-MM-DD, optional) |
| `check_out` | string | no | — | Check-out (YYYY-MM-DD, optional) |
| `enrich_user_profiles` | boolean | no | `true` | Fetch host + co-host profiles (default true) |
| `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.listing`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "url": "https://www.airbnb.com/rooms/946231329459150209",
    "listing": {
      "id": "946231329459150209",
      "title": "Modern Apartment with Stunning Views",
      "url": "https://www.airbnb.com/rooms/946231329459150209?...",
      "thumbnail": "https://a0.muscache.com/im/pictures/xxx.jpg",
      "property_type": "Apartment",
      "room_type": "Entire home/apt",
      "person_capacity": 4,
      "coordinates": {
        "latitude": 40.7128,
        "longitude": -74.006
      },
      "rating": {
        "accuracy": 4.9,
        "cleanliness": 4.8,
        "guest_satisfaction": 4.85,
        "reviews_count": 127
      },
      "host": {
        "id": "12345",
        "name": "John",
        "is_super_host": true
      },
      "amenities": [
        {
          "title": "Essentials",
          "values": [
            {
              "title": "Wifi",
              "available": true
            }
          ]
        }
      ],
      "is_available": true,
      "currency": "USD",
      "locale": "en-US"
    },
    "next_cursor": null
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `url` | string | `https://www.airbnb.com/rooms/946231329459150209` |  |
| `listing` | object | `{…}` | The results. |
| `next_cursor` | null | `null` | Pass back as `cursor` for the next page. `null` on the last page. |
| `listing.id` | string | `946231329459150209` |  |
| `listing.title` | string | `Modern Apartment with Stunning Views` |  |
| `listing.url` | string | `https://www.airbnb.com/rooms/9462313294591502…` |  |
| `listing.thumbnail` | string | `https://a0.muscache.com/im/pictures/xxx.jpg` |  |
| `listing.property_type` | string | `Apartment` |  |
| `listing.room_type` | string | `Entire home/apt` |  |
| `listing.person_capacity` | integer | `4` |  |
| `listing.coordinates` | object | `{…}` |  |
| `listing.rating` | object | `{…}` |  |
| `listing.host` | object | `{…}` |  |
| `listing.amenities` | array | `[1 item]` |  |
| `listing.is_available` | boolean | `true` |  |
| `listing.currency` | string | `USD` |  |
| `listing.locale` | string | `en-US` |  |

## 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-room-urls/"
HEADERS = {"X-API-Key": "YOUR_API_KEY"}
params = {"url": "https://www.airbnb.com/rooms/668146487515150072"}
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.append(data.get("listing"))
    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 Listing Search](https://docs.scrapier.io/api-reference/airbnb/airbnb-listings.md): Structured Airbnb data: send `query`. Cursor-paginated, 1 credit per successful call.
- [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.
