Zillow Search
Structured Zillow data: send url. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “Overview”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).
Request
Section titled “Request”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 210const params = new URLSearchParams({ 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 res = await fetch(`https://api.scrapier.io/api/v2/zillow-search/?${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.listings);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/zillow-search/", headers={"X-API-Key": "YOUR_API_KEY"}, 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"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["listings"])curl -X POST "https://api.scrapier.io/api/v2/zillow-search/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"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 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.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 | Zillow 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). |
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. |
method | string | no | zoom | Scrape 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 |
delay | string | no | 1 | Delay between requests in seconds (decimals OK). Applied to both methods |
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.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" }}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.listings.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
url | string | https://www.zillow.com/homes/for_sale/?search… | — |
page | integer | 1 | — |
page_size | integer | 40 | — |
listings | array | [1 item] | The results. |
next_cursor | string | eyJoIjoiYWJjMTIzIiwicCI6MiwidSI6Imh0dHBzOi8vd… | Pass back as cursor for the next page. null on the last page. |
listings[].zpid | string | 12345678 | — |
listings[].detailUrl | string | https://www.zillow.com/homedetails/.../123456… | — |
listings[].address | string | 123 Main St | — |
listings[].city | string | San Francisco | — |
listings[].state | string | CA | — |
listings[].zipcode | string | 94110 | — |
listings[].price | integer | 1250000 | — |
listings[].bedrooms | integer | 3 | — |
listings[].bathrooms | integer | 2 | — |
listings[].livingArea | integer | 1450 | — |
listings[].homeStatus | string | FOR_SALE | — |
listings[].foundFromSearchUrl | string | https://www.zillow.com/homes/for_sale/?search… | — |
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/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 };}import requests
URL = "https://api.scrapier.io/api/v2/zillow-search/"HEADERS = {"X-API-Key": "YOUR_API_KEY"}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"}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.extend(data.get("listings") or []) 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”- Zillow Property Detail — Structured Zillow data: send
urls. Single lookup, 1 credit per successful call.