Skip to content

Buildings (multi-unit)

For Zillow URLs of the form /b/<id>, /apartments/<id>, or /community/<id>, where one URL represents a building containing many unit listings.

GET /v1/buildings/by-url

QueryTypeRequiredNotes
urlstringyesBuilding/apartments/community URL
include_unitsenumnoall (default), for_sale, for_rent, recently_sold, off_market
syncboolnotrue (default). Set false for large buildings — returns a job_id.

Sync 200 response

{
"data": {
"units": [
{ "zpid": "1100...", "unitNumber": "201", "price": 425000, "beds": 1, "baths": 1, "...": "..." },
{ "zpid": "1100...", "unitNumber": "302", "price": 489000, "beds": 2, "baths": 2, "...": "..." }
]
},
"meta": { "count": 47, "include_units": "for_sale" },
"request_id": "..."
}

Async 202 response (when sync=false)

{ "data": { "job_id": "8c2a...", "status": "running" }, "request_id": "..." }

Notes

  • A building can return hundreds of units. Use sync=false for large condos/apartments.
  • Units are charged at 1 unit each. A 200-unit building = 200 result units.
  • The first item is sometimes the building’s parent record (no unitNumber); units follow.