> Documentation index: https://docs.scrapier.io/llms.txt
> Auth: header `X-API-Key: <key>` · Base: https://api.scrapier.io/api/v2 · Synchronous; paginate with `cursor` ← `data.next_cursor`.

# Zillow Property Detail

Structured Zillow data: send `urls`. Single lookup, 1 credit per successful call.

`GET|POST https://api.scrapier.io/api/v2/zillow-detail/` · 1 credit per successful call · Single lookup · Long-running

## Overview

Call `GET /api/v2/zillow-detail/` with `urls`. The results are in `data.property`. 1 optional parameter refines the call (see Parameters).

## Request

```bash
curl -G "https://api.scrapier.io/api/v2/zillow-detail/" \
  -H "X-API-Key: YOUR_API_KEY" \
  --data-urlencode "urls=https://www.zillow.com/homedetails/17-Zelma-Dr-Greenville-SC-29617/11026031_zpid/" \
  --max-time 210
```

```python
import requests

resp = requests.get(
    "https://api.scrapier.io/api/v2/zillow-detail/",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"urls": "https://www.zillow.com/homedetails/17-Zelma-Dr-Greenville-SC-29617/11026031_zpid/"},
    timeout=210,
)
body = resp.json()
if not resp.ok:
    raise RuntimeError(body.get("error") or body.get("detail"))

print(body["data"]["property"])
```

POST with a JSON body works too (same parameters; the body is merged over the query string).

## Parameters

| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| `X-API-Key` (header) | string | yes | — | Your API key. |
| `urls` | string | yes | e.g. `https://www.zillow.com/homedetails/17-Zelma-Dr-Greenville-SC-29617/11026031_zpid/` | A Zillow detail URL or address. One record; 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. |
| `use_proxy` | boolean | no | `true` | Route the request through Scrapier's residential proxy pool. Default: `true`. Leave as is unless support tells you otherwise. |
| `raw_data` | boolean | no | `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

HTTP 200. Results are in `data.property`. Sample from the live catalog, arrays trimmed to 3 items.

```json
{
  "success": true,
  "data": {
    "urls": "https://www.zillow.com/homedetails/17-Zelma-Dr-Greenville-SC-29617/11026031_zpid/",
    "property": {
      "zpid": 11026031,
      "is_valid": true,
      "street_address": "17 Zelma Dr",
      "city": "Greenville",
      "state": "SC",
      "home_status": "RECENTLY_SOLD",
      "home_type": "SINGLE_FAMILY",
      "price": 415000,
      "bedrooms": 4,
      "bathrooms": 3,
      "address_or_url_from_input": "https://www.zillow.com/homedetails/17-Zelma-Dr-Greenville-SC-29617/11026031_zpid/",
      "scraped_at": "2026-06-24T12:00:00.000Z"
    },
    "next_cursor": null
  }
}
```

## Response fields

| Field | Type | Example | Description |
|---|---|---|---|
| `urls` | string | `https://www.zillow.com/homedetails/17-Zelma-D…` |  |
| `property` | object | `{…}` | The results. |
| `next_cursor` | null | `null` | Pass back as `cursor` for the next page. `null` on the last page. |
| `property.zpid` | integer | `11026031` |  |
| `property.is_valid` | boolean | `true` |  |
| `property.street_address` | string | `17 Zelma Dr` |  |
| `property.city` | string | `Greenville` |  |
| `property.state` | string | `SC` |  |
| `property.home_status` | string | `RECENTLY_SOLD` |  |
| `property.home_type` | string | `SINGLE_FAMILY` |  |
| `property.price` | integer | `415000` |  |
| `property.bedrooms` | integer | `4` |  |
| `property.bathrooms` | integer | `3` |  |
| `property.address_or_url_from_input` | string | `https://www.zillow.com/homedetails/17-Zelma-D…` |  |
| `property.scraped_at` | string | `2026-06-24T12:00:00.000Z` |  |

## Pagination

Single lookup: everything comes back in one call and `next_cursor` is always `null`.

## Errors

Failed calls are free. Branch on HTTP status; the message is in `error` (or `detail`). See https://docs.scrapier.io/errors.md

- **400** Bad input. The exact message varies by endpoint. `{"success":false,"error":"…"}`
- **402** Balance below the endpoint's price. `{"error":"Insufficient credits. Buy more to scrape more.","balance":1,"required":2}`
- **403** Invalid or unknown API key. `{"detail":"Authentication service unavailable or invalid API key."}`
- **429** Throttled — wait for Retry-After. `{"detail":"Request was throttled. Expected available in N seconds."}`
- **404** unknown slug · **503** busy (retry after `Retry-After`) · **5xx** upstream failure or timeout (retry with backoff).

## Notes

- This endpoint can take several minutes. Set your client timeout to at least 210 seconds.

## Related

- [Zillow Search](https://docs.scrapier.io/api-reference/zillow/zillow-search.md): Structured Zillow data: send `url`. Cursor-paginated, 1 credit per successful call.
