realestate.co.nz places

The regions, districts and suburbs realestate.co.nz searches by, with their ids and paths (use the path or name as location in /realestate-nz/v1/search). Filter by name and type.

Every response includes credits_used: the credits this call cost.

Parameters

Every endpoint also takes fresh, raw, fields (see lean responses and caching).

Example

curl "https://api.api.sh/realestate-nz/v1/places?q=ponsonby" \
  -H "x-api-key: $APISH_KEY"

import os, requests

res = requests.get(
    "https://api.api.sh/realestate-nz/v1/places",
    params={"q": "ponsonby"},
    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/places");
url.searchParams.set("q", "ponsonby");

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).