Documentation
Guides and references for the Ipsofax lookup API and the drop-in autocomplete widget.
Guides
API endpoints
| Endpoint | Description |
|---|---|
| GET /v1/{dataset}/suggest | Typeahead suggestions β free |
| GET /v1/{dataset}/typeahead | Complete one field (locality, street, postcode, state) β free |
| GET /v1/{dataset}/postcode-lookup | List addresses for a 4-digit postcode + first 3 street letters β free |
| GET /v1/{dataset}/resolve | Resolve a selected suggestion β 1 credit |
| GET /v1/{dataset}/validate | Validate a one-line address β 1 credit on a match |
| GET /v1/{dataset}/nearest | Reverse geocode a point β 1 credit when addresses are found |
| GET /v1/{dataset}/datasets | Dataset metadata, fields and capabilities β free |
Dataset codes: au-gnaf and nz-linz are live today.
Authentication & quotas
On the website β the widget talks to ipsofax.com directly. The live demo is rate-limited and needs no key; a free account adds a starter bundle of lookups and an API key.
From your own backend β API keys are coming soon. Accounts are issued a small starter bundle for when keys are enabled; until then, use the hosted widget and the live examples.
Suggestions, postcode listings and dataset metadata are always free. A credit is charged only when a lookup resolves to a verified address β see what is a lookup?