API reference

Zillow Building and Units API

Building details and unit-level rents, beds, area, required fees and availability dates. Records can include future availability; base rent and mandatory fees remain separate.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/zillow/buildinglive · proven1 credit

Try in Playground

Parameters

Query parameters

Useful optional inputs

dry_run — Read a free estimate before fetching sources or scheduling paid work.
Zero credits; cache status and availability are snapshots rather than guarantees.

Name	Required	Description	Example
`url`	yes	Zillow apartment-building page URL.	`https://www.zillow.com/apartments/austin-tx/alexan-st.-elmo/C8gzfc/`
`dry_run`	no	Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/zillow/building?url=https%3A%2F%2Fwww.zillow.com%2Fapartments%2Faustin-tx%2Falexan-st.-elmo%2FC8gzfc%2F" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/zillow/building?url=https%3A%2F%2Fwww.zillow.com%2Fapartments%2Faustin-tx%2Falexan-st.-elmo%2FC8gzfc%2F",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/zillow/building?url=https%3A%2F%2Fwww.zillow.com%2Fapartments%2Faustin-tx%2Falexan-st.-elmo%2FC8gzfc%2F",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "zillow",
  "endpoint": "/v1/zillow/building",
  "data": {
    "_warnings": [
      "example"
    ],
    "amenities": [
      "example"
    ],
    "city": "example",
    "country": "example",
    "currency": "example",
    "description": "example",
    "floor_plans": [
      {
        "available_from_at": "2026-09-01T12:00:00Z",
        "available_from_utc": 0,
        "base_rent_max": 0,
        "base_rent_min": 0,
        "baths": 0,
        "beds": 0,
        "lease_term": "example",
        "name": "example",
        "photos": [
          "example"
        ],
        "price_max": 0,
        "price_min": 0,
        "required_monthly_fee_max": 0,
        "required_monthly_fee_min": 0,
        "sqft": 0,
        "units": [
          {}
        ],
        "units_available": 0
      }
    ],
    "full_address": "example",
    "latitude": 0,
    "longitude": 0,
    "name": "example",
    "photos": [
      {
        "sources": [
          {}
        ],
        "url": "https://example.com/example"
      }
    ],
    "platform": "example",
    "rent_max": 0,
    "rent_min": 0,
    "reported_available_units": 0,
    "state": "example",
    "type": "example",
    "unit_records": 0,
    "units": [
      {
        "available_from_at": "2026-09-01T12:00:00Z",
        "base_rent": 0,
        "baths": 0,
        "beds": 0,
        "list_price_includes_required_fees": false,
        "price": 0,
        "required_monthly_fee_max": 0,
        "required_monthly_fee_min": 0,
        "sqft": 0,
        "unit_number": "example",
        "zpid": "example"
      }
    ],
    "url": "https://example.com/example",
    "zipcode": "example"
  },
  "credits_used": 1,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`_warnings`	`array \| null`	Optional warnings supplied by this operation. Null means unknown.
`amenities`	`array \| null`	Optional amenities supplied by this operation. Null means unknown.
`city`	`string \| null`	Optional city supplied by this operation. Null means unknown.
`country`	`string \| null`	Optional country supplied by this operation. Null means unknown.
`currency`	`string \| null`	Optional currency supplied by this operation. Null means unknown.
`description`	`string \| null`	Source description; null or absent means not supplied.
`floor_plans`	`array \| null`	Optional floor plans supplied by this operation. Null means unknown.
`floor_plans[].available_from_at`	`string \| null`	Optional available from at supplied by this operation. Null means unknown.
`floor_plans[].available_from_utc`	`number \| null`	Optional available from utc supplied by this operation. Null means unknown.
`floor_plans[].base_rent_max`	`number \| null`	Optional base rent max supplied by this operation. Null means unknown.
`floor_plans[].base_rent_min`	`number \| null`	Optional base rent min supplied by this operation. Null means unknown.
`floor_plans[].baths`	`number \| null`	Optional baths supplied by this operation. Null means unknown.
`floor_plans[].beds`	`number \| null`	Optional beds supplied by this operation. Null means unknown.
`floor_plans[].lease_term`	`string \| null`	Optional lease term supplied by this operation. Null means unknown.
`floor_plans[].name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`floor_plans[].photos`	`array \| null`	Optional photos supplied by this operation. Null means unknown.
`floor_plans[].price_max`	`number \| null`	Optional price max supplied by this operation. Null means unknown.
`floor_plans[].price_min`	`number \| null`	Optional price min supplied by this operation. Null means unknown.
`floor_plans[].required_monthly_fee_max`	`number \| null`	Optional required monthly fee max supplied by this operation. Null means unknown.
`floor_plans[].required_monthly_fee_min`	`number \| null`	Optional required monthly fee min supplied by this operation. Null means unknown.
`floor_plans[].sqft`	`number \| null`	Optional sqft supplied by this operation. Null means unknown.
`floor_plans[].units`	`array \| null`	Optional units supplied by this operation. Null means unknown.
`floor_plans[].units_available`	`number \| null`	Optional units available supplied by this operation. Null means unknown.
`full_address`	`string \| null`	Optional full address supplied by this operation. Null means unknown.
`latitude`	`number \| null`	Optional latitude supplied by this operation. Null means unknown.
`longitude`	`number \| null`	Optional longitude supplied by this operation. Null means unknown.
`name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`photos`	`array \| null`	Optional photos supplied by this operation. Null means unknown.
`photos[].sources`	`array \| null`	Optional sources supplied by this operation. Null means unknown.
`photos[].url`	`string \| null`	Original source URL when supplied.
`platform`	`string \| null`	Optional platform supplied by this operation. Null means unknown.
`rent_max`	`number \| null`	Optional rent max supplied by this operation. Null means unknown.
`rent_min`	`number \| null`	Optional rent min supplied by this operation. Null means unknown.
`reported_available_units`	`number \| null`	Optional reported available units supplied by this operation. Null means unknown.
`state`	`string \| null`	Optional state supplied by this operation. Null means unknown.
`type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`unit_records`	`number \| null`	Optional unit records supplied by this operation. Null means unknown.
`units`	`array \| null`	Optional units supplied by this operation. Null means unknown.
`units[].available_from_at`	`string \| null`	Optional available from at supplied by this operation. Null means unknown.
`units[].base_rent`	`number \| null`	Optional base rent supplied by this operation. Null means unknown.
`units[].baths`	`number \| null`	Optional baths supplied by this operation. Null means unknown.
`units[].beds`	`number \| null`	Optional beds supplied by this operation. Null means unknown.
`units[].list_price_includes_required_fees`	`boolean \| null`	Optional list price includes required fees supplied by this operation. Null means unknown.
`units[].price`	`number \| null`	Source price. Currency, taxes and availability depend on the listing.
`units[].required_monthly_fee_max`	`number \| null`	Optional required monthly fee max supplied by this operation. Null means unknown.
`units[].required_monthly_fee_min`	`number \| null`	Optional required monthly fee min supplied by this operation. Null means unknown.
`units[].sqft`	`number \| null`	Optional sqft supplied by this operation. Null means unknown.
`units[].unit_number`	`string \| null`	Optional unit number supplied by this operation. Null means unknown.
`units[].zpid`	`string \| null`	Optional zpid supplied by this operation. Null means unknown.
`url`	`string \| null`	Original source URL when supplied.
`zipcode`	`string \| null`	Optional zipcode supplied by this operation. Null means unknown.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

Zillow Building and Units API

Query parameters

Make the request

Response fields and example

Useful next calls

First call in under a minute