Skip to content

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

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

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

Terminal window
curl -G "https://api.scrapier.io/api/v2/airbnb-listings/" \
-H "X-API-Key: YOUR_API_KEY" \
--data-urlencode "query=London" \
--max-time 210
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
querystringyese.g. LondonLocation to search (city, neighborhood, etc.). Required on first call; ignored when cursor is supplied.
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.
checkinstringno2026-12-01Check-in date (YYYY-MM-DD). Locked into the cursor on first call.
checkoutstringno2026-12-08Check-out date (YYYY-MM-DD). Locked into the cursor on first call.
currencystringnoUSDCurrency code (USD, EUR, GBP, ...). Locked into the cursor.
localestringnoen-USLocale (en-US, fr-FR, ...). Locked into the cursor.
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": {
"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..."
}
}

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

FieldTypeExampleDescription
querystringLondon—
checkinstring2026-01-01—
checkoutstring2026-01-08—
currencystringUSD—
localestringen-US—
page_sizeinteger18—
listingsarray[1 item]The results.
next_cursorstringzc1.eNoBVQGq_gAAAEt7InEiOiJMb25kb24i...Pass back as cursor for the next page. null on the last page.
listings[].idstring569049214818933247—
listings[].titlestringStunning Loft in Downtown London—
listings[].urlstringhttps://www.airbnb.com/rooms/569049214818933247—
listings[].thumbnailstringhttps://a0.muscache.com/im/pictures/miso/xxx.jpg—
listings[].descriptionstringBeautiful loft with panoramic views...—
listings[].currencystringUSD—
listings[].localestringen-US—
listings[].rating_accuracynumber4.9—
listings[].rating_checkinginteger5—
listings[].rating_cleanlinessnumber4.8—
listings[].rating_communicationnumber4.9—
listings[].rating_locationnumber4.9—
listings[].rating_valuenumber4.7—
listings[].rating_guest_satisfactionnumber4.85—
listings[].rating_reviews_countinteger127—
listings[].price_amountstring$1,015—
listings[].price_labelstring$1,015 for 7 nights—
listings[].price_qualifierstringfor 7 nights—
listings[].latitudenumber51.5074—
listings[].longitudenumber-0.1278—
listings[].keywordstringLondon—
listings[].positioninteger1—

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-listings/";
let params = { query: "London" };
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.listings ?? []));
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.