Skip to content

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

GET · POST1 credit / successful callCursor-paginated
GEThttps://api.scrapier.io/api/v2/airbnb-room-urls/Open in Playground

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

Terminal window
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
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
urlstringyese.g. https://www.airbnb.com/rooms/668146487515150072Airbnb listing URL. Returns full structured detail. This is a lookup endpoint — next_cursor is always null.
cursorstringno—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.
currencystringnoUSDCurrency code
localestringnoen-USLocale
adultsintegerno2Adults
childrenintegerno0Children
petsintegerno0Pets
check_instringno—Check-in (YYYY-MM-DD, optional)
check_outstringno—Check-out (YYYY-MM-DD, optional)
enrich_user_profilesbooleannotrueFetch host + co-host profiles (default true)
Advanced
NameTypeDefaultDescription
use_proxybooleantrueRoute the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise.
raw_databooleanfalseWhen 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.
{
"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
}
}

Sample from the live catalog; arrays trimmed to 3 items. Results are in data.listing.

FieldTypeExampleDescription
urlstringhttps://www.airbnb.com/rooms/946231329459150209—
listingobject{…}The results.
next_cursornullnullPass back as cursor for the next page. null on the last page.
listing.idstring946231329459150209—
listing.titlestringModern Apartment with Stunning Views—
listing.urlstringhttps://www.airbnb.com/rooms/9462313294591502…—
listing.thumbnailstringhttps://a0.muscache.com/im/pictures/xxx.jpg—
listing.property_typestringApartment—
listing.room_typestringEntire home/apt—
listing.person_capacityinteger4—
listing.coordinatesobject{…}—
listing.ratingobject{…}—
listing.hostobject{…}—
listing.amenitiesarray[1 item]—
listing.is_availablebooleantrue—
listing.currencystringUSD—
listing.localestringen-US—

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 };
}

Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.

StatusMeaningRetry?Charged?
400Bad or missing input.No — fix the paramsNo
401 / 403Missing, invalid or revoked API key.No — fix the keyNo
402Out of credits (body has balance).No — top upNo
404Unknown endpoint slug.No — check the slugNo
429 / 503Busy or throttled.Yes — after Retry-AfterNo
5xxTarget site or upstream failure, or timeout.Yes — with backoffNo
  • Nothing special: send the inputs, read the result.