# 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](/guides/addresses/quickstart) to geocode an address, assess the match, and retrieve its attributes using v2.

| You have… | Use |
| --- | --- |
| An address string or components | [Geocode](/reference/addresses-v2-address-search#geocode-2) |
| Latitude and longitude | [Reverse Geocode](/reference/addresses-v2-address-search#reverse-geocode-2) |
| An address, street, or locality ID | [Get address by ID](/reference/addresses-v2-address-verification#get-address-by-id) |
| A jurisdictional parcel identifier | [Find addresses by parcel ID](/reference/addresses-v2-address-search#find-addresses-by-parcel-id) |
| A Geoscape or jurisdictional property identifier | [Find addresses by property ID](/reference/addresses-v2-address-search#find-addresses-by-property-id) |
| A postal address requiring a DPID and barcode | [MailPoint](/reference/addresses-v2-address-search#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](/guides/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 `features` array. 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). Use `Accept-Crs` to request another supported CRS
- Read request-level and feature-level `messages`, and retain the returned `attribution`

Use [Assessing Address Matches](/guides/addresses/assessing-matches) for matching definitions and point detail, and [Match Quality Examples](/guides/addresses/match-quality-examples) for annotated comparisons.

## Further guidance

- [Additional Properties](/guides/addresses/additional-properties): choose optional attributes and check access, units, and credit costs
- [Addresses from Coordinates](/guides/addresses/reverse-geocoding): choose a search method and assess nearby results
- [Postal Address Matching](/guides/addresses/mailpoint): interpret DPID, barcode, and postal matching results
- [CRS & GDA2020](/guides/gda-2020): select input and response coordinate systems
- [Error Handling](/guides/errors), [Rate Limiting](/guides/rate-limiting), and [Attribution](/guides/attribution): apply shared integration requirements

## Versions

| Version | Reference |
| --- | --- |
| v2 (current) | [Endpoint reference](/reference/addresses-v2-address-search) |
| v1 (legacy) | [Endpoint reference](/reference/addresses-v1-address) |

Use the current version for new integrations. Legacy identifies an older version. Individual deprecated endpoints are marked in the reference.
