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.
Authorization
ApiKeyAuth In: header
Query Parameters
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.
"for_sale_by_agent"Value in
- "for_sale_by_agent"
- "for_sale_by_owner"
- "new_construction"
- "auction"
- "pending"
- "recently_sold"
- "for_rent"
- "off_market"
- "other"
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.
0 <= value <= 9990Where 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.
0 <= value <= 10000000How 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.
1 <= value <= 500001000curl -X GET "https://example.com/v1/zillow/sitemap" \ -H "x-api-key: YOUR_API_KEY"{ "data": { "family": "for_sale_by_agent", "shard": 0, "offset": 0, "limit": 1000, "properties": [ { "zpid": "2146999031", "url": "https://www.zillow.com/homedetails/2114-S-Trumbull-Ave-Chicago-IL-60623/2146999031_zpid/" } ], "count": 1000, "shard_count": 34, "shard_total": 50000, "has_more": true, "source_url": "https://www.zillow.com/xml/sitemaps/us/hdp/for-sale-by-agent/sitemap-0000.xml.gz", "usage_note": "Each zpid is the exact value /zillow/property takes. These come from Zillow's public sitemaps, which need no credential and, unlike property pages, no fresh identity per request." }}