realestate.co.nz listing
One realestate.co.nz listing: everything in a search result plus the full description, features, floor plans, videos, virtual tours, nearby schools (with zoning) and childcare, broadband and links, with the price history, open homes, the office (name, phone, email, website, logo) and agents (name, phone, mobile, email, photo); a private listing has no office or agents. Give the listing id, a realestate.co.nz listing link as url, or latest=true with the search params to open the first current result. Also the auction, tender or deadline-sale date (deadline), council rates (rates, rates_period), body-corporate levy (body_corp_levy, body_corp_levy_period), area units (floor_area_unit, land_area_unit), full bathrooms and the agency's offer and document links (action_links).
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
id | string | Listing id (id of a search result). |
url | string | A realestate.co.nz listing link. |
latest | boolean | true: run the search with the other params and open its first current result. Example: true |
location | string | With latest=true: the search place. Example: auckland |
category | res_sale | res_rent | rural_sale | lifestyle_sale | lifestyle_lease | com_sale | com_lease | biz_sale | With latest=true: listing category. |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/realestate-nz/v1/listing" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/realestate-nz/v1/listing",
params={},
headers={"x-api-key": os.environ["APISH_KEY"]},
timeout=120,
)
res.raise_for_status()
data = res.json() const url = new URL("https://api.api.sh/realestate-nz/v1/listing");
const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json(); Response
A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).