WattleAddr API
Add Australian address autocomplete, verification and geocoding to any application. Base URL https://api.wattleaddr.com.au/v1. JSON only. Australian addresses only.
Quickstart
Grab a publishable key (browser) and a secret key (server) from the console, then wire up the drop-in widget:
<script src="https://api.wattleaddr.com.au/v1/widget.js"></script>
// 2. attach it to an input (publishable key, domain-locked)
const wa = new WattleAddr('waddr_pk_live_…');
wa.attach('#address', { onSelect: (a) => console.log(a.formatted) });
Authentication
Two key types, both created in the console. Never expose a secret key in the browser.
| Key | Prefix | Where | Secured by |
|---|---|---|---|
| Secret | waddr_sk_live_… | Server-side | Authorization: Bearer + optional IP allowlist |
| Publishable | waddr_pk_live_… | Browser | Allowed referrer domains + rate limits |
Endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /v1/addresses/autocomplete | Type-ahead suggestions for a partial query |
GET | /v1/addresses/{id} | Full structured record for a chosen suggestion (billable) |
POST | /v1/addresses/verify | Match free-text to the best canonical address + confidence |
GET | /v1/status | Service health & current G-NAF release |
Example — autocomplete
-H "Authorization: Bearer waddr_sk_live_…"
"suggestions": [
{ "id": "GANSW706124693", "formatted": "1 Martin Place, Sydney NSW 2000" }
]
}
Rate limits & billing
Billing is session-based: send a session token with each autocomplete keystroke and the final retrieve — the whole session counts as one billable lookup. Responses include X-WattleAddr-Quota-Remaining; exceeding your plan returns 429 with a Retry-After header.
Attribution
WattleAddr is built on the open Geocoded National Address File. The G-NAF licence requires attribution — display this wherever you surface address data:
licensed under the Open G-NAF End User Licence Agreement.
Full reference, SDKs and an interactive playground are on the way. Questions? hello@wattleaddr.com.au