Autocomplete - Lite

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 Australian Government-published Geocoded National Address File (GNAF). The data set is also augmented with additional local government attributes from the Australia Bureau of Statistics.

Autocomplete can be used only with Metadata.

Supported Plans:

Lite

Addresser Autocomplete - Lite

Based on our predictive search, returns an array of partial/full match complete address for the given components of the user input address.

GET
Example Usage
https://api.addresser.com.au/basicautocompletev2?search_word=12

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for 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

states=nsw,qld
states=nsw

https://api.addresser.com.au/basicautocompletev2?search_word=12?search_word=12&states=qld&pdt=1

Australian Capital Territory - ACT
New South Wales - NSW
Northern Territory - NT
Queensland - QLD
South Australia - SA
Tasmania - TAS
Victoria - VIC
Westerna Australia - WA

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": "200 GEORGE ST SYDNEY NSW 2000",
            "FULL_ADDRESS_HIGHLIGHTED":" <strong>200</strong> <strong>GEORGE</strong> <strong>ST</strong> <strong>SYDNEY</strong> <strong>NSW</strong> <strong>2000</strong>",
            "_id": "1ieAjocxxxxxxxxxxx",
        }
        ]
    }

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.
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.
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.
Below example error code and message. 
              {
                "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.

 200 GEORGE ST SYDNEY NSW 2000
_id String

Unique record identifier of the address

 1ieAjocxxxxxxxxxxx
FULL_ADDRESS_HIGHLIGHTED String

The 'FULL_ADDRESS_HIGHLIGHTED' response highlights text using 'strong' tags based on the provided input.

 "<strong>200</strong> <strong>GEORGE</strong> <strong>ST</strong> <strong>SYDNEY</strong> <strong>NSW</strong> <strong>2000</strong>"

Metadata - Lite

API Documentation

Introduction

The API provides capability to access the metadata of selected address from the auto complete API

Metadata can be used only with Autocomplete variant to access relevant metadata of the address.

Supported Plans:

Lite

HTTP over SSL

https://api.addresser.com.au/basicmetadatav2

Addresser - Metadata V2

Retrieves all metadata for selected Address from the Autocomplete address match results.

GET

Example Usage

https://api.addresser.com.au/basicmetadatav2?_id=qNBni5MB_******

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for paid plans, via the "My Crendentials" section after logging into the "My Addresser" portal.

Parameter

Field Type Description
_id String

Record identifier from the Autocomplete search results.

Success Response

[
    {
        "GNAF_ADDRESS_DETAIL_PID": "GAVIC412367690",
        "GNAF_BUILDING_NAME": "",
        "GNAF_LOT_NUMBER_PREFIX": "",
        "GNAF_LOT_NUMBER": "",
        "GNAF_LOT_NUMBER_SUFFIX": "",
        "GNAF_FLAT_TYPE": "UNIT",
        "GNAF_FLAT_NUMBER_PREFIX": "",
        "GNAF_FLAT_NUMBER": 12,
        "GNAF_FLAT_NUMBER_SUFFIX": "",
        "GNAF_LEVEL_TYPE": null,
        "GNAF_LEVEL_NUMBER_PREFIX": "",
        "GNAF_LEVEL_NUMBER": null,
        "GNAF_LEVEL_NUMBER_SUFFIX": "",
        "GNAF_NUMBER_FIRST_PREFIX": "",
        "GNAF_NUMBER_FIRST": 12,
        "GNAF_NUMBER_FIRST_SUFFIX": "",
        "GNAF_NUMBER_LAST_PREFIX": "",
        "GNAF_NUMBER_LAST": null,
        "GNAF_NUMBER_LAST_SUFFIX": "",
        "GNAF_STREET_LOCALITY_PID": "VIC2025390",
        "GNAF_STREET_NAME": "PAKINGTON",
        "GNAF_STREET_TYPE_ABBR": "ST",
        "GNAF_STREET_SUFFIX_CODE": null,
        "GNAF_LOCALITY_NAME": "ST KILDA",
        "GNAF_STATE_ABBREVIATION": "VIC",
        "GNAF_POSTCODE": "3182",
        "GNAF_LATITUDE": -37.86567757,
        "GNAF_LONGITUDE": 144.98717681,
        "GNAF_GEOCODE_TYPE": "FRONTAGE CENTRE SETBACK",
        "GNAF_CONFIDENCE": 2,
        "GNAF_LEGAL_PARCEL_ID": "1\\LP76774",
        "GNAF_ADDRESS_MESH_BLOCK_2016_PID": "VIC1536643898",
        "GNAF_MB_2016_PID": "MB1620631953110",
        "GNAF_MB_MATCH_CODE_2016": "1",
        "GNAF_MB_2016_CODE": "20631953110",
        "GNAF_MBMC_2016_NAME": "PARCEL LEVEL MATCH",
        "GNAF_ADDRESS_MESH_BLOCK_2021_PID": "VIC1580729143",
        "GNAF_MB_2021_PID": "MB2121328680000",
        "GNAF_MB_MATCH_CODE_2021": "1",
        "GNAF_MB_2021_CODE": "21328680000",
        "GNAF_MBMC_2021_NAME": "PARCEL LEVEL MATCH",
        "GNAF_FULL_ADDRESS": "U 12 12 PAKINGTON ST ST KILDA VIC 3182",
        "GNAF_ADDRESS_LINE_1": "UNIT 12",
        "GNAF_ADDRESS_LINE_2": "12 PAKINGTON ST",
        "GNAF_ADDRESS_LINE_3": "ST KILDA VIC 3182",
        "GNAF_ADDRESS_LINE_4": "AUSTRALIA",
        "LGA_MB_CODE_2021": "21328680000",
        "LGA_CODE_2021": "25900",
        "LGA_NAME_2021": "PORT PHILLIP",
        "LGA_STATE_CODE_2021": "2",
        "LGA_STATE_NAME_2021": "VICTORIA",
        "LGA_AUS_CODE_2021": "AUS",
        "LGA_AUS_NAME_2021": "AUSTRALIA",
        "LGA_AREA_ALBERS_SQKM": 0.0099,
        "LGA_ASGI_LOCI_URI_2021": "HTTP://LINKED.DATA.GOV.AU/DATASET/ASGSED3/MB/21328680000",
        "DATA_SOURCE": "AU_GNAF"
    }
]

API Errors

{
  "errorCode": xxxx,
  "errorMessage": "xxx"
}
Error Code Description Resolution
4073

Supplied identifier is invalid.

Call support to helpdesk to resolve this issue.
4071

_id is misssing.

Include the _id query string parameter.
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 documenation.
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 additional quota via Pricing page of the Addresser website.

 
{
  "errorCode": 4072,
  "errorMessage": "search_word cannot be empty."
}

Response Specification

Field Type Explanation Example
GNAF_ADDRESS_DETAIL_PID

String

Unique address identifier of GNAF dataset.

GAVIC412367690
GNAF_BUILDING_NAME

String

Building name, if available.
GNAF_LOT_NUMBER_PREFIX

String

Prefix of the LOT number.

GNAF_LOT_NUMBER

String

LOT number of the address provided by GNAF dataset.

GNAF_LOT_NUMBER_SUFFIX

String

Suffix of the LOT number.

GNAF_FLAT_TYPE

String

UNIT type name

UNIT
GNAF_FLAT_NUMBER_PREFIX

String

Flat number prefix, if any

GNAF_FLAT_NUMBER

String

Flat number

12
GNAF_FLAT_NUMBER_SUFFIX

String

Flat number suffix, if any
GNAF_LEVEL_TYPE

String

Level type name

GNAF_LEVEL_NUMBER_PREFIX

String

Level number prefix, if any.

GNAF_LEVEL_NUMBER

String

Level number.

GNAF_LEVEL_NUMBER_SUFFIX

String

Level number suffix, if any.

GNAF_NUMBER_FIRST_PREFIX

String

Street number first prefix, if any.

GNAF_NUMBER_FIRST

String

Street number of the address

12
GNAF_NUMBER_FIRST_SUFFIX

String

Street number first suffix, if any.

GNAF_NUMBER_LAST_PREFIX

String

Street number last (for ranged addresses only), if any.

GNAF_NUMBER_LAST

String

Street number last (for ranged addresses only), if any.

GNAF_NUMBER_LAST_SUFFIX

String

Street number last (for ranged addresses only) suffix, if any.

GNAF_STREET_LOCALITY_PID

String

Unique locality identifier.

VIC2025390
GNAF_STREET_NAME

String

Street name

PAKINGTON
GNAF_STREET_TYPE_ABBR

String

Street type abbreviation

ST
GNAF_STREET_SUFFIX_CODE

String

Street suffix code

GNAF_LOCALITY_NAME

String

Suburb/Locality name

ST KILDA
GNAF_STATE_ABBREVIATION

String

State abbreviation

VIC
GNAF_POSTCODE

Number

Post code

3182
GNAF_LATITUDE

Number

Latitude pertaining to the geolocation of the address.

-37.86567757
GNAF_LONGITUDE

Number

Longitute pertaining to the geolocation of the address.

144.98717681
GNAF_GEOCODE_TYPE

String

Geocode type.

FRONTAGE CENTRE SETBACK
GNAF_CONFIDENCE

Number

Confidence level of geocode

2
GNAF_LEGAL_PARCEL_ID

String

Legal parcel identifier.

1\\LP76774
GNAF_ADDRESS_MESH_BLOCK_2016_PID

String

2016 Australian Meshblock PID.

VIC1536643898
GNAF_MB_2016_PID

String

2016 MB PID

MB1620631953110
GNAF_MB_MATCH_CODE_2016

String

2016 MB match code

1
GNAF_MB_2016_CODE

String

2016 MB code

20631953110
GNAF_MBMC_2016_NAME

String

2016 MB MC code

PARCEL LEVEL MATCH
GNAF_ADDRESS_MESH_BLOCK_2021_PID

String

2021 Mesh block PID

VIC1580729143
GNAF_MB_2021_PID

String

2021 MB PID

MB2121328680000
GNAF_MB_MATCH_CODE_2021

String

2021 MB Match code

1
GNAF_MB_2021_CODE

String

2021 MB code

21328680000
GNAF_MBMC_2021_NAME

String

2021 MB MC code

PARCEL LEVEL MATCH
GNAF_FULL_ADDRESS

String

Combined full address string based on GNAF data.

U 12 12 PAKINGTON ST ST KILDA VIC 3182
GNAF_ADDRESS_LINE_1

String

Standardized Address Line 1

UNIT 12
GNAF_ADDRESS_LINE_2

String

Standardized Address Line 2

12 PAKINGTON ST
GNAF_ADDRESS_LINE_3

String

Standardized Address Line 3

ST KILDA VIC 3182
GNAF_ADDRESS_LINE_4

String

Standardized Address Line 4

AUSTRALIA
LGA_MB_CODE_2021

String

2021 Meshblock code corresponding to Local government data.

21328680000
LGA_CODE_2021

String

2021 LGA code.

25900
LGA_NAME_2021

String

2021 Local government area name.

PORT PHILLIP
LGA_STATE_CODE_2021

String

State code as per Local government dataset.

2
LGA_STATE_NAME_2021

String

State name as per Local government dataset.

VICTORIA
LGA_AUS_CODE_2021

String

Country code as per Local government dataset.

AUS
LGA_AUS_NAME_2021

String

Country name as per Local government dataset.

AUSTRALIA
LGA_AREA_ALBERS_SQKM

String

Local government area coverage in square kilometres.

0.0099
LGA_ASGI_LOCI_URI_2021

String

Local government area reference dataset URI.

HTTP://LINKED.DATA.GOV.AU/DATASET/ASGSED3/MB/21328680000
DATA_SOURCE

String

Source for the metadata returned by Addresser

AU_GNAF