BETA - Predictive AV API

  • Version: 1.7.0-beta
  • Host: api.psma.com.au/beta/v1
  • Protocols: https
  • Accepts: application/json
  • Responds With: application/json

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

What is The Predictive AV API?

The Predictive AV (Address Verification) API is an address autocomplete service aimed at businesses and developers that want a single national source of government recognised addresses. The API takes in a partially completed address string and returns suggestions of the most likely address the user was trying to enter, to speed up address form completion or other address needs.

We’ve implemented a range of “fuzzy” logic, improving the suggestions returned by the API. This includes alias matching, neighbouring suburb matching, vanity suburb correction, misspelling matching and HTTP parameters, giving implementation-specific controls making better matches given a particular use-case.

Why should you use this Predictive API?

PSMA has been and will continue to be the author of GNAF (Geocoded National Address File) the national authority on address. PSMA takes addresses seriously; we believe we must have the latest and most accurate address holdings in the country. We’re undertaking great technical efforts to increase the usability and fuzzy logic to return better and better results.

More control to you

PSMA is actively developing more controls for you, the developer. The first is a parameter to control which address dataset suggestions are made against. We also have state-based filtering to limit the scope of suggestions to a smaller address list giving you better suggestions.

How you use the API

To use the API you’ll need to first get back suggestions of possible address matches by calling the GET Suggested Addressesendpoint. This API requires at a minimum a four char string to start giving you suggestions. Once you have a suggestion that matches the users’ target address, the returned suggestion id which is linked to the target address can be fed into the GET an Address Call. This call returns a detailed list of address attributes describing the selected address. The address information can be used to fill in forms and update your records within a database.