Addresses API

  • Version: 1.4.0
  • Host: api.psma.com.au/v1
  • Protocols: https
  • Responds With: application/json

Looking for Addresses API version 2? Click here

Note: The rest of the documentation is for Addresses API version 1.

What is the Addresses API?

The Addresses API is a comprehensive, RESTful resource that aims to answer any question about addresses in Australia. It offers multiple services for finding addresses reverse geocoding, address validation, geocoding, filtering and customisation of search results and will return many different pieces of information about a given address.

NEW

Support for spatial representation in different datums through the use of a new Configurable CRS System

We’ve added support to the Predictive API to allow you to control the CRS used when presenting spatial data. Depending on your use-case you might need data represented in WGS 84 (a global datum) or GDA-2020 Australia’s new datum. With this new feature, you can control the spatial representation through a new header removing the need for complex transformation on your client end. This feature is essential as the government and other entities that use spatial data start the move to Australias new Datum GDA-2020, for more detail on what GDA-2020 is or why you should care about the spatial accuracy of your data, please refer to this fantastic video created by Small Island Studio for the ICSM

Using this new feature

To use this new feature, all you need to do is pass in an additional header in the form of an Accept-Crs header. Our backend system reads this new header, and we perform a transformation of the spatial location (latitude and longitude) to return a spatial point in the correct datum for your use-case.

This new feature is entirely optional and will not change the experience of the API for any existing users, you’re able to add in support for this new feature as you require it.

Supported CRSs

  1. GDA 94 - <https://www.opengis.net/def/crs/EPSG/0/4283>
  2. GDA 2020 - <https://www.opengis.net/def/crs/EPSG/0/7844>
  3. WGS 84 - <https://www.opengis.net/def/crs/EPSG/0/4326>
  4. AGD 66 - <https://www.opengis.net/def/crs/EPSG/0/4202>

Further resources on Datums and spatial accuracy


Key concepts you should know before you start developing

  • Attributes are pieces of information about a specific resource. An example would be the geospatial coordinates of an address or what local government area that address belongs to.
  • Resources are the representation of a thing or an object that can have some data attached to it (attribute). Examples are a specific address, a building or a parcel of land. We will often have unique identifiers for these things.
  • Methods are the operation that is being performed on a resource. Examples are get, update and delete
  • Collections are sets of logically grouped resources. Examples are addresses, properties, suburbs and hospitals
  • URL or (Uniform Resource Locator) is the path to the resource.

Remembering these key concepts will help you to navigate our APIs quickly and efficiently.

To use the Addresses API you’ll need to purchase a bundled API plan. All bundled API plans have a defined amount of credit to consume over a month or year. Your credit is drawn down based on the number of attributes returned via the API. You’ll never be charged for attributes we didn’t give you and you didn’t request.

Geocoding

In its simplest form Geocoding is the process of converting a physical address (a description of a location often a street address) into a spatial representation measured in latitude and longitude. In Australia, we use the coordinate reference system GDA94 (Geocentric Datum of Australia 1994. You can learn more about geocoding here or about GDA 94 here.

Reverse-Geocoding

Reverse-geocoding is exactly what it sounds like, it’s the process of converting a spatial latitude and longitude into a physical address.

Address Validation

Not all addresses are the same, people often refer to the same location by many different names. The process of Address Validation has the aim to turn validate or correct a user understood address into a trusted authoritative address. In doing this we create a common trusted understanding of the location being described. Some examples of the key features of a good address validator are handling of alias names, correction and interpretation of miss spellings and consistency of naming convention.

Links to Pricing

Bundled API Plans