# List sitemap properties

List a window of property IDs and URLs from a Zillow sitemap shard. Each `zpid` can be used with the property and history endpoints.

- Platform: Zillow
- Request: `GET https://api.toolzerhub.com/v1/zillow/sitemap`
- Auth: `x-api-key` header
- Cost: 1 credit per successful request. Failed requests are not billed.
- Page: https://docs.toolzerhub.com/reference/zillow/discovery/get-zillow-sitemap

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `family` | query | no | enum: for_sale_by_agent, for_sale_by_owner, new_construction, auction, pending, recently_sold, for_rent, off_market, other | Which of Zillow's sitemap families to read: for_sale_by_agent (default), for_sale_by_owner, new_construction, auction, pending, recently_sold, for_rent, off_market, or other. Zillow's srp, cdp and bdp sitemaps are not offered — their entries carry no zpid. Default: for_sale_by_agent. |
| `shard` | query | no | integer | Which shard of the family's index to read, from 0. A full shard holds 50,000 property URLs. Shard count varies by family and is read live — check shard_count on the response. A shard past the end of a family is a 400. Default: 0. |
| `offset` | query | no | integer | Where in the shard to start. Add the count you received to the offset you sent to get the next window, and stop when has_more is false. A window past the end of a shard is a normal empty response with has_more: false, not an error. Default: 0. |
| `limit` | query | no | integer | How many properties to return in one call, up to a full shard (50,000). Defaults to 1,000. The shard is cached after the first read, so later windows return in microseconds. Default: 1000. |

## Example request

```bash
curl "https://api.toolzerhub.com/v1/zillow/sitemap" \
  -H "x-api-key: $TOOLZERHUB_API_KEY"
```

Success responses are wrapped as `{ "data": ... }`. Errors return `{ "error": { "code", "status", "message", "retryable", "details" } }`. See https://docs.toolzerhub.com/docs/responses-and-errors.