Autocomplete - V3
API Documentation
Introduction
Autocomplete uses text search to find addresses based on our proprietary matching algorithm that incorporates advanced searching and filtering capabilities. The API provides the capability to custom-build your own auto-complete functionality for desktop, web, and mobile applications.
Addresser autocomplete is based on data from both Australian Government-published Geocoded National Address File (GNAF) and Australia Postal Address File. The data set is also augmented with additional local government attributes from the Australia Bureau of Statistics.
Autocomplete can be used only with Metadata.
Addresser Autocomplete V3
Based on our predictive search, returns an array of partial/full match complete address for the given components of the user input address.
GEThttps://api.addresser.com.au/autocompletev3
Example Usage
https://api.addresser.com.au/autocompletev3?search_word=12&gnaf=0&pdt=0
Request Headers
Field | Type | Description |
---|---|---|
x-api-key | String |
Your API key. You can access API Key after registering for either our 7-day free "Starter" or any other paid plans, via the "My Credentials" section after logging into the "My Addresser" portal. |
Parameter
Field | Type | Description |
---|---|---|
search_word | String |
Partial address searched for. |
states optional | String |
Specific filter state codes to limit the search to specific states or territories. Comma-separated state codes should be used.
Usage
Australian Capital Territory - ACT |
pdt required | Integer |
Postal delivery types are included by default (i.e. pdt=0 and gnaf=0) in the autocomplete search excluding GNAF, the pdt filter should be used to either include only physical dwellings or exclusively include Postal Delivery Types. Usage scenarios below: |
gnaf required | Integer |
gnaf=1 include GNAF in search and results. |
limit optional | Integer |
Default to 10, range between 10 and 20. |
Response
The success response from the API consists of Suggestions array (Suggestions[]) consisting of three elements – a single line formatted address, unique identifier pertaining to that specific dataset version and each suggestion accompanied by Sources array (Source[]) identifying the potential data sources used to produce the curated address.
200 Success Response Structure
{ "Suggestions": [ { "FULL_ADDRESS": "L 23 L 23 200 GEORGE ST SYDNEY NSW 2000 2000", "FULL_ADDRESS_HIGHLIGHTED":"<strong>L</strong> <strong>23</strong> <strong>200</strong> <strong>GEORGE</strong> <strong>ST</strong> <strong>SYDNEY</strong> <strong>NSW</strong> <strong>2000</strong>", "_id": "1ieAjocxxxxxxxxxxx", "SOURCE": [ "AU_PAF", "AU_GNAF", "LGA" ] } ] }
API Errors
{ "errorCode": xxxx, "errorMessage": "xxx" }
Error Code | Description | Resolution |
---|---|---|
4073 |
Supplied Parameter is invalid |
One of parameter is empty or has an invalid value. |
4071 |
search_word is missing |
Parameter search_word is missing. |
4072 |
search_word cannot be empty |
Input partial address into the search_word query string of the request URL. |
4064 |
limit cannot be empty. |
Input 'limit' cannot be empty. |
4065 |
states cannot be empty |
Input valid comma-separate state codes to filter the results. |
4066 |
Invalid state name provided. |
One or more of the state codes are invalid. |
4067 |
Postal Delivery Type (pdt) cannot be empty. |
Input valid pdt type (0 or 1) to the pdt query string. |
4068 |
Invalid Postal Delivery Type (pdt) name provided |
pdt type can be either 0 or 1. |
4076 |
API key is missing or invalid. |
Check the API Key, you can get the correct API Key from the "Credentials" section of "My Addresser" portal. |
4077 |
Invalid Method or API URL. |
You have used an incorrect URL. Check the URL from the API documentation. |
4080 |
You have exceeded the allowed quota. |
You have reached the maximum limit of API calls on your current plan. You can choose to add an additional quota via the Pricing page of the Addresser website. |
4003 |
Internal Server Error |
This is a server-side issue. |
{ "errorCode": 4072, "errorMessage": "search_word cannot be empty." }
Response Specification
Field | Type | Description | Example |
---|---|---|---|
FULL_ADDRESS | String |
Full address response the input partial address. The address data provided is based on the data source availability. Australia Post address is returned if available otherwise GNAF address. |
L 23 200 GEORGE ST SYDNEY NSW 2000 |
FULL_ADDRESS_HIGHLIGHTED | String |
The 'FULL_ADDRESS_HIGHLIGHTED' response highlights text using 'strong' tags based on the provided input. |
<strong>L</strong> <strong>23</strong> <strong>200</strong> <strong>GEORGE</strong> <strong>ST</strong> <strong>SYDNEY</strong> <strong>NSW</strong> <strong>2000</strong> |
_id | String |
Unique record identifier of the address |
1ieAjocxxxxxxxxxxx |
SOURCE | Array |
An array of strings based on the number of data sources the address is curated from. |
AU_PAF |