getAddressSuggestion

GET

Suggest Addresses

This endpoint returns address suggestions from a partial address. 

 

Notes:

  1. Searching for addresses has a 50 character limit on the query parameter. This limit also considers the full length of abbreviated words. For example, RD in a search query will expand to ROAD, which will count as 4 characters. Breaching this limit will return no results.
  2. It is recommended to use call throttling/debouncing to cancel earlier suggest requests that have been superseded by a later one. There are plenty of examples of how to implement this available on the web.
  3. A successful query that results in no suggestions will return an empty array of suggestions.

Resource URL

https://api.psma.com.au /predictive/address

Query Parameters

Name Values Description
query
(required)

The query to use to obtain address suggestions.

maxNumberOfResults

The maximum number of results to return. Maximum is 10. Default is 5.

stateTerritory

Restricts suggested addresses to a list of states or territories. Examples:

  • NSW - Suggest addresses from New South Wales only
  • VIC,WA - Suggest addresses from Victoria or Western Australia only
  • ALL - Apply no state or territory restriction

Header Parameters

Name Values Description
API-Key
(required)

This is used to identify the app.

Accept

It accepts application/json, text/json, application/vnd.geo+json, application/xml, text/xml, and application/gml+xml as content-types.

Try it out !!

HTTP Basic

OAuth 2.0

API Key

RESET

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Data Dictionary

Resource Summary

Security

Category

Predictive Address

Working...