realestate.co.nz agent
A real-estate agent on realestate.co.nz: name, job title, agent number, status, phone, mobile, email, website, LinkedIn, photo, their offices (name, phone, email, website, logo), the categories and areas of their active listings, the suburbs they work in, current, recent and all-time listing counts, and their current listings (with the search filters, sort and paging).
Every response includes credits_used: the credits this call cost.
Parameters
| name | type | description |
|---|---|---|
idrequired | string | Agent id (agents[].id of a listing or an office). Example: 29735 |
category | res_sale | res_rent | rural_sale | lifestyle_sale | lifestyle_lease | com_sale | com_lease | biz_sale | Listing category of their listings (default: the agent's first category). |
sort | featured | best-match | latest | oldest | lowest-price | highest-price | Sort order of their listings. |
limit | integer | Listings per page (max 50). |
page | integer | Result page (1 = first). |
Every endpoint also takes fresh, raw, fields (see lean responses and caching).
Example
curl "https://api.api.sh/realestate-nz/v1/agent?id=29735" \
-H "x-api-key: $APISH_KEY" import os, requests
res = requests.get(
"https://api.api.sh/realestate-nz/v1/agent",
params={"id": "29735"},
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/agent");
url.searchParams.set("id", "29735");
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).