Airbnb Room URL Scraper
Structured Airbnb data: send url. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “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
Section titled “Request”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 210const params = new URLSearchParams({ url: "https://www.airbnb.com/rooms/668146487515150072" });
const res = await fetch(`https://api.scrapier.io/api/v2/airbnb-room-urls/?${params}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000),});const body = await res.json();if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
console.log(body.data.listing);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"])curl -X POST "https://api.scrapier.io/api/v2/airbnb-room-urls/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"url":"https://www.airbnb.com/rooms/668146487515150072"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
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) |
Advanced
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | 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
Section titled “Response”{ "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 }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.listing.
Response fields
Section titled “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
Section titled “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. More in Pagination.
const url = "https://api.scrapier.io/api/v2/airbnb-room-urls/";let params = { url: "https://www.airbnb.com/rooms/668146487515150072" };const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call const res = await fetch(`${url}?${new URLSearchParams(params)}`, { headers: { "X-API-Key": "YOUR_API_KEY" }, signal: AbortSignal.timeout(210_000), }); const body = await res.json(); if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`); const data = body.data; items.push(data.listing); if (!data.next_cursor) break; // null = last page params = { cursor: data.next_cursor };}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
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- Nothing special: send the inputs, read the result.
Related
Section titled “Related”- Airbnb Listing Search — Structured Airbnb data: send
query. Cursor-paginated, 1 credit per successful call. - Airbnb Occupancy / Availability — Structured Airbnb data: send
room_id. Cursor-paginated, 1 credit per successful call. - Airbnb Price Tracker — Structured Airbnb data: send
url. Cursor-paginated, 1 credit per successful call. - Airbnb Reviews Scraper — Structured Airbnb data: send
url. Cursor-paginated, 1 credit per successful call.