1. Get access and create a key
Request an account , verify your email, and wait for approval. Then create a named key in API keys . The full key is shown once.
The x-api-key header is also supported. Keep keys in your server environment; never
include them in client-side JavaScript or a public URL.
2. Create an estimate
Send JSON to the endpoint below. The default poll mode returns HTTP 202 with
a job_id. Save that ID to retrieve the result.
Need a single response?
Set mode to request to wait for processing. Allow at least 120 seconds in your HTTP client. A 200 response can contain a failed status; always check the JSON status.
Request fields
Field | Required | Description |
|---|---|---|
| address | Required | Full property address, 3–240 characters. |
| country | Defaults to AU | Two-letter country code, for example AU, NZ or GB. |
| reference | Optional | Your own reference, up to 200 characters. Returned with the result. |
| property_type | Optional | house or unit. Omit it when unknown. |
| mode | Defaults to poll | poll returns a request receipt; request waits for the result. |
| known_details | Optional | Known numeric attributes: bedrooms, bathrooms, car_spaces, land_size_sqm, building_size_sqm. Omit unknown values. |
3. Retrieve and use the result
While the status is queued or running, poll every few seconds
with a delay between attempts. Stop when the status is completed, failed or cancelled. You can only retrieve your own requests.
Completed result · illustrative example
The status endpoint includes lifecycle metadata in addition to these result fields. Use the returned currency and valuation date. A recent compatible estimate may be reused, so the valuation date can precede the request date. Confidence describes the available information and is not a guarantee of accuracy.
To stop a queued or running request, send POST /api/v1/jobs/YOUR_JOB_ID/cancel with the same authentication header.
Handle failures explicitly
- 400 / 422: check the request fields and JSON format.
- 401: supply a valid API key.
- 403: the account is not approved or its access has been paused.
- 404: the request does not exist or belongs to another account.
- 429 / 5xx: wait before retrying. Respect a Retry-After header if one is returned.
A finished request can have a failed status, including when there is insufficient
property information. Never substitute zero for a missing estimate. Review the request in your
workspace before creating another one.
A reference is not an idempotency key
Each call to the v1 creation endpoint can create a new request. If your connection drops, check your workspace before submitting again. Reusing a reference does not prevent duplicates.