Developers

API

The same engine the panel uses, over HTTP. Bearer auth, JSON out, one price: $0.20 per address resolved and read. Identity and the registry are unmetered — you only pay when you actually read a site.

Get an API key Pricing

Quickstart

curl -H "Authorization: Bearer $XYREF_KEY" \
  "https://www.xyref.com/api/v1/site?address=7+Webb+Street+North+Parramatta+NSW+2151"

Endpoints

GET /v1/resolve?address= free

Resolve free text to a register address — property id, GURAS id, coordinates, confidence and the flags behind the score. Unmetered: it is the identity step every other call depends on.

GET /v1/site?address= metered

The full nine-card read for one address — every source, every value, every receipt. Meters one address.

GET /v1/site/:source?address= metered

One source only (planning, parcel, transport, terrain…). Meters the address once, however many sources you pull from it that month.

GET /v1/sources free

The connector registry — every source with its endpoint, licence, fields and the clauses it answers.

GET /account/bookmarks free

Your saved addresses, with the coordinates and register ids resolved at save time.

Receipts in JSON

Every value comes back with source, query, retrieved_at, licence, clause and confidence beside it — not in a separate metadata block you have to join back.

Failures are named

A source that times out returns a named error in its own slot; the rest of the report still returns 200. You always know which register was unreachable, rather than getting a shorter report with no explanation.

Billing

An address that fails to resolve is never charged. On Pro and Max the monthly cap is drawn down first; past it, calls fall back to credit at $0.20 rather than failing.