Read as Markdown · Use with an AI agent
Endpoint
GET/v1/zillow/search-soldlive · proven1 creditParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
location | yes | City/region in the United States or Canada. | Austin, TX |
min_price | no | Minimum listing price. | |
max_price | no | Maximum listing price. | 600000 |
min_beds | no | Minimum bedrooms. | 3 |
sort | no | Newest listings first. Only newest is supported. | newest |
cursor | no | Opaque continuation from this operation; preserve all original parameters. | |
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. | 1 |
Examples
Make the request
curl
curl "https://www.monocrawl.com/v1/zillow/search-sold?location=Austin%2C%20TX" \ -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/search-sold?location=Austin%2C%20TX",
{ 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/search-sold?location=Austin%2C%20TX",
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 envelope
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/search-sold",
"data": {
"…": "See the response guide and inspect this endpoint in the Playground"
},
"credits_used": 1,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}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