API reference
Zillow Property API
Property listing price, photos, description, basic facts and optional estimated values. Historical prices, tax history and school data are not supported.
Endpoint
/v1/zillow/propertylive · proven1 creditParameters
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 |
|---|---|---|---|
id | yes | Numeric identifier from a parent result. | 29479546 |
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 "https://www.monocrawl.com/v1/zillow/property?id=29479546" \ -H "x-api-key: mn_your_key_here"
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/property?id=29479546",
{ 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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/zillow/property?id=29479546",
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.
{
"success": true,
"platform": "zillow",
"endpoint": "/v1/zillow/property",
"data": {
"_warnings": [
"example"
],
"address": "example",
"area_sqft": 0,
"bathrooms": 0,
"bedrooms": 0,
"city": "example",
"country": "example",
"description": "example",
"facts": {
"appliances": [],
"bathrooms_full": 0,
"bathrooms_half": 0,
"cooling": [],
"heating": [],
"lot_area_units": "example",
"lot_area_value": 0,
"parking_capacity": 0,
"parking_features": [
"example"
],
"price_per_square_foot": 0,
"year_built": 0
},
"id": "example",
"latitude": 0,
"longitude": 0,
"photos": [
"example"
],
"platform": "example",
"postcode": "example",
"price": {
"amount": 0,
"currency": "example"
},
"property_type": "example",
"region": "example",
"status": "example",
"type": "example",
"url": "https://example.com/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. |
address | string | null | Optional address supplied by this operation. Null means unknown. |
area_sqft | number | null | Optional area sqft supplied by this operation. Null means unknown. |
bathrooms | number | null | Optional bathrooms supplied by this operation. Null means unknown. |
bedrooms | number | null | Optional bedrooms 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. |
description | string | null | Source description; null or absent means not supplied. |
facts | object | null | Optional facts supplied by this operation. Null means unknown. |
facts.appliances | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
facts.bathrooms_full | number | null | Optional bathrooms full supplied by this operation. Null means unknown. |
facts.bathrooms_half | number | null | Optional bathrooms half supplied by this operation. Null means unknown. |
facts.cooling | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
facts.heating | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
facts.lot_area_units | string | null | Optional lot area units supplied by this operation. Null means unknown. |
facts.lot_area_value | number | null | Optional lot area value supplied by this operation. Null means unknown. |
facts.parking_capacity | number | null | Optional parking capacity supplied by this operation. Null means unknown. |
facts.parking_features | array | null | Optional parking features supplied by this operation. Null means unknown. |
facts.price_per_square_foot | number | null | Optional price per square foot supplied by this operation. Null means unknown. |
facts.year_built | number | null | Optional year built supplied by this operation. Null means unknown. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
latitude | number | null | Optional latitude supplied by this operation. Null means unknown. |
longitude | number | null | Optional longitude supplied by this operation. Null means unknown. |
photos | array | null | Optional photos supplied by this operation. Null means unknown. |
platform | string | null | Optional platform supplied by this operation. Null means unknown. |
postcode | string | null | Optional postcode supplied by this operation. Null means unknown. |
price | object | null | Source price. Currency, taxes and availability depend on the listing. |
price.amount | number | null | Optional amount supplied by this operation. Null means unknown. |
price.currency | string | null | Optional currency supplied by this operation. Null means unknown. |
property_type | string | null | Optional property type supplied by this operation. Null means unknown. |
region | string | null | Optional region supplied by this operation. Null means unknown. |
status | string | null | Optional status supplied by this operation. Null means unknown. |
type | string | null | Optional type supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
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