Addresses API
Use this page to choose an Addresses API operation, prepare your first request, and find guidance on interpreting its results.
When to use this API
Geocode Australian addresses, find addresses from coordinates, retrieve address attributes, and match postal addresses with MailPoint.
Start with the Addresses Quickstart to geocode an address, assess the match, and retrieve its attributes using v2.
| You have… | Use |
|---|---|
| An address string or components | Geocode |
| Latitude and longitude | Reverse Geocode |
| An address, street, or locality ID | Get address by ID |
| A jurisdictional parcel identifier | Find addresses by parcel ID |
| A Geoscape or jurisdictional property identifier | Find addresses by property ID |
| A postal address requiring a DPID and barcode | MailPoint |
Access: Use a Geoscape Hub application with Addresses API access. MailPoint and premium additional properties require paid-plan access.
Send its Consumer Key directly in the Authorization header. See Authentication for application and tester setup.
Responses
- Searches return GeoJSON feature collections. An ID lookup returns a single feature
- A successful geocoding request can return an empty
featuresarray. Review the match type, quality, score, and component feedback before accepting a candidate - Point coordinates use
[longitude, latitude]order. The default response CRS is GDA94 (EPSG:4283). UseAccept-Crsto request another supported CRS - Read request-level and feature-level
messages, and retain the returnedattribution
Use Assessing Address Matches for matching definitions and point detail, and Match Quality Examples for annotated comparisons.
Further guidance
- Additional Properties: choose optional attributes and check access, units, and credit costs
- Addresses from Coordinates: choose a search method and assess nearby results
- Postal Address Matching: interpret DPID, barcode, and postal matching results
- CRS & GDA2020: select input and response coordinate systems
- Error Handling, Rate Limiting, and Attribution: apply shared integration requirements
Versions
| Version | Reference |
|---|---|
| v2 (current) | Endpoint reference |
| v1 (legacy) | Endpoint reference |
Use the current version for new integrations. Legacy identifies an older version. Individual deprecated endpoints are marked in the reference.