Skip to content

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

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

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

Terminal window
curl -G "https://api.scrapier.io/api/v2/zillow-search/" \
-H "X-API-Key: YOUR_API_KEY" \
--data-urlencode "url=https://www.zillow.com/homes/for_sale/?searchQueryState=%7B%22isMapVisible%22%3Atrue%2C%22mapBounds%22%3A%7B%22west%22%3A-124.61%2C%22east%22%3A-120.37%2C%22south%22%3A36.71%2C%22north%22%3A38.74%7D%2C%22filterState%22%3A%7B%22sort%22%3A%7B%22value%22%3A%22days%22%7D%7D%2C%22isListVisible%22%3Atrue%7D" \
--max-time 210
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
urlstringyese.g. https://www.zillow.com/homes/for_sale/?searchQueryState=%7B%22isMapVisible%22%3Atrue%2C%22mapBounds%22%3A%7B%22west%22%3A-124.61%2C%22east%22%3A-120.37%2C%22south%22%3A36.71%2C%22north%22%3A38.74%7D%2C%22filterState%22%3A%7B%22sort%22%3A%7B%22value%22%3A%22days%22%7D%7D%2C%22isListVisible%22%3Atrue%7DZillow search URL — must contain a searchQueryState query param with at least mapBounds AND filterState. A bare ?searchQueryState={"isMapVisible":true} URL parses fine but Zillow returns an empty list (no actual search filter).
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.
methodstringnozoomScrape method: 'zoom' (Zillow's map search API) or 'html' (__NEXT_DATA__). Aliases: extraction_method, extractionMethod. Legacy: PAGINATION_WITH_ZOOM_IN / MAP_MARKERS → zoom; PAGINATION_WITHOUT_ZOOM_IN / HTML → html
delaystringno1Delay between requests in seconds (decimals OK). Applied to both methods
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.zillow.com/homes/for_sale/?searchQueryState=...",
"page": 1,
"page_size": 40,
"listings": [
{
"zpid": "12345678",
"detailUrl": "https://www.zillow.com/homedetails/.../12345678_zpid/",
"address": "123 Main St",
"city": "San Francisco",
"state": "CA",
"zipcode": "94110",
"price": 1250000,
"bedrooms": 3,
"bathrooms": 2,
"livingArea": 1450,
"homeStatus": "FOR_SALE",
"foundFromSearchUrl": "https://www.zillow.com/homes/for_sale/?searchQueryState=..."
}
],
"next_cursor": "eyJoIjoiYWJjMTIzIiwicCI6MiwidSI6Imh0dHBzOi8vd3d3LnppbGxvdy5jb20vaG9tZXMvZm9yX3NhbGUvIn0"
}
}

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

FieldTypeExampleDescription
urlstringhttps://www.zillow.com/homes/for_sale/?search…—
pageinteger1—
page_sizeinteger40—
listingsarray[1 item]The results.
next_cursorstringeyJoIjoiYWJjMTIzIiwicCI6MiwidSI6Imh0dHBzOi8vd…Pass back as cursor for the next page. null on the last page.
listings[].zpidstring12345678—
listings[].detailUrlstringhttps://www.zillow.com/homedetails/.../123456…—
listings[].addressstring123 Main St—
listings[].citystringSan Francisco—
listings[].statestringCA—
listings[].zipcodestring94110—
listings[].priceinteger1250000—
listings[].bedroomsinteger3—
listings[].bathroomsinteger2—
listings[].livingAreainteger1450—
listings[].homeStatusstringFOR_SALE—
listings[].foundFromSearchUrlstringhttps://www.zillow.com/homes/for_sale/?search…—

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/zillow-search/";
let params = { url: "https://www.zillow.com/homes/for_sale/?searchQueryState=%7B%22isMapVisible%22%3Atrue%2C%22mapBounds%22%3A%7B%22west%22%3A-124.61%2C%22east%22%3A-120.37%2C%22south%22%3A36.71%2C%22north%22%3A38.74%7D%2C%22filterState%22%3A%7B%22sort%22%3A%7B%22value%22%3A%22days%22%7D%7D%2C%22isListVisible%22%3Atrue%7D" };
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.