Beta Addresses API
- Version: 1.3
- Host: api.psma.com.au/beta/v1
- Responds With:
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
geocoding, filtering and customisation of search results and will return many different pieces of information about a given address.
Simplified and unified error messages. All messages are now an
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
- Collections are sets of logically grouped resources. Examples are
- 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.
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 is exactly what it sounds like, it’s the process of converting a spatial latitude and longitude into a physical address.
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.