Autocomplete - V2

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 V2

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

GET
https://api.addresser.com.au/autocompletev2
Example Usage
https://api.addresser.com.au/autocompletev2?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

states=nsw,qld
states=nsw

https://api.addresser.com.au/autocompletev2?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

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:

Scenario 1 - Include GNAF, exclude Post Delivery Types
This scenario is catered to use cases where only physical dwellings are to be included in the autocomplete. The pdt filter must be set to '0' and gnaf filter must be set to '1'.
Example Usage
https://api.addresser.com.au/autocompletev2?search_word=12&pdt=0&gnaf=1

Scenario 2 - Include only Postal Delivery Types
This scenario is catered to use cases where only postal delivery types such as "PO BOX", "MAIL BAG" etc., are to be included in the autocomplete, and do not include any physical dwellings. For this to work pdt filter must be set to '1' and gnaf filter must be set to '0'.
Example Usage
https://api.addresser.com.au/autocompletev2?search_word=12&pdt=1&gnaf=0

NOTE: GNAF and POSTAL DELIVERY TYPES are mutually exclusive therefore both the filters cannot be set to '1'.

gnaf required Integer

gnaf=1 include GNAF in search and results.
gnaf=0 exclude GNAF from 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": "200 George St Sydney NSW 2000",
            "_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.

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 address auto-complete calls

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
_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 – Australia Post Address File.
• GNAF- Geocoded National Address File.
• LGA – Australia Bureau of Statistics information used to augment local government information.

AU_PAF

Metadata - V2

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.

HTTP over SSL

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

Addresser - Metadata V2

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

GET
https://api.addresser.com.au/metadatav2

Example Usage

https://api.addresser.com.au/metadatav2?_id=IR0mYoIBI7s5ZeO1Twrd

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for either our 14-day free "Starter" or any other 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.

gnaf Integer

1 – Include GNAF data in the response (Default).
0 – Exclude GNAF data in the response.
Note: Excluding GNAF will include “NULL” values for all GNAF attributes.

Success Response

The success response from the API consists of single record of fields from the curated dataset consisting of Australia Post, GNAF and additional Local Government area-related information. Please note not all addresses have all three sets of information available.

                    [
                      {
                          "SOURCES": [
                              "AU_GNAF",
                              "AU_PAF",
                              "LGA"
                          ],
                          "AU_GNAF": {
                              "GNAF_ADDRESS_DETAIL_PID": "GANSW717343923",
                              "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": 1283,
                              "GNAF_NUMBER_FIRST_SUFFIX": "",
                              "GNAF_NUMBER_LAST_PREFIX": "",
                              "GNAF_NUMBER_LAST": 1287,
                              "GNAF_NUMBER_LAST_SUFFIX": "",
                              "GNAF_STREET_LOCALITY_PID": "NSW2940817",
                              "GNAF_STREET_NAME": "PITTWATER",
                              "GNAF_STREET_TYPE_ABBR": "RD",
                              "GNAF_STREET_SUFFIX_CODE": null,
                              "GNAF_LOCALITY_NAME": "NARRABEEN",
                              "GNAF_STATE_ABBREVIATION": "NSW",
                              "GNAF_POSTCODE": "2101",
                              "GNAF_LATITUDE": -33.72153669,
                              "GNAF_LONGITUDE": 151.29792387,
                              "GNAF_GEOCODE_TYPE": "PROPERTY CENTROID",
                              "GNAF_CONFIDENCE": 2,
                              "GNAF_LEGAL_PARCEL_ID": "12/SP78412",
                              "GNAF_ADDRESS_MESH_BLOCK_2016_PID": "NSW1558501559",
                              "GNAF_MB_2016_PID": "MB1611204701600",
                              "GNAF_MB_MATCH_CODE_2016": "1",
                              "GNAF_MB_2016_CODE": "11204701600",
                              "GNAF_MBMC_2016_NAME": "PARCEL LEVEL MATCH",
                              "GNAF_ADDRESS_MESH_BLOCK_2021_PID": "NSW1571700942",
                              "GNAF_MB_2021_PID": "MB2111204701600",
                              "GNAF_MB_MATCH_CODE_2021": "1",
                              "GNAF_MB_2021_CODE": "11204701600",
                              "GNAF_MBMC_2021_NAME": "PARCEL LEVEL MATCH",
                              "GNAF_FULL_ADDRESS": "U 12 1283-1287 PITTWATER RD NARRABEEN NSW 2101",
                              "COUNTRY_CODE": "AU"
                          },
                          "AU_PAF": {
                              "DELIVY_POINT_GROUP_ID": 387497,
                              "DELIVY_POINT_ID": 46360072,
                              "THOROUGHFARE_NBR_1": "1283",
                              "THOROUGHFARE_NBR_SFX_1": null,
                              "THOROUGHFARE_NBR_2": "1287",
                              "THOROUGHFARE_NBR_SFX_2": null,
                              "FLAT_UNIT_TYPE": "U",
                              "FLAT_UNIT_NBR": "12",
                              "FLOOR_LEVEL_TYPE": null,
                              "FLOOR_LEVEL_NBR": null,
                              "LOT_NBR": null,
                              "POSTAL_DELIVERY_NBR": null,
                              "POSTAL_DELIVERY_NBR_PFX": null,
                              "POSTAL_DELIVERY_NBR_SFX": null,
                              "PRIMARY_POINT_IND": null,
                              "BLDG_PROP_NAME_1": null,
                              "BLDG_PROP_NAME_2": null,
                              "LOCALITY_ID": 3435,
                              "STREET_NAME": "PITTWATER",
                              "STREET_TYPE": "RD",
                              "STREET_SFX": null,
                              "POSTAL_DELIVERY_TYPE": null,
                              "DELIVY_POINT_GROUP_DID": null,
                              "LOCALITY_NAME": "NARRABEEN",
                              "POSTCODE": "2101",
                              "STATE": "NSW",
                              "LOCALITY_DID": null,
                              "LOCALITY_NAME_SYNONYM": null,
                              "TYPE_ACTN_CODE": null,
                              "ST_ALT_STREET_NAME": null,
                              "ST_ALT_STREET_TYPE": null,
                              "ST_ALT_STREET_SFX": null,
                              "BORDERING_LOCALITY_NAME": "INGLESIDE, CROMER, WHEELER HEIGHTS, COLLAROY, NORTH NARRABEEN, COLLAROY PLATEAU",
                              "BORDERING_POSTCODE": "2101, 2099, 2097, 2097, 2101, 2097",
                              "FULL_ADDRESS": "U 12 1283-1287 PITTWATER RD NARRABEEN NSW 2101",
                              "PAF_EXPIRY": "2023-06-31",
                              "COUNTRY_CODE": "AU"
                          },
                          "LGA": {
                              "LGA_MB_CODE_2021": "11204701600",
                              "LGA_STATE_CODE_2021": "1",
                              "LGA_STATE_NAME_2021": "NEW SOUTH WALES",
                              "LGA_AUS_CODE_2021": "AUS",
                              "LGA_AUS_NAME_2021": "AUSTRALIA",
                              "LGA_AREA_ALBERS_SQKM": 0.0072,
                              "LGA_ASGI_LOCI_URI_2021": "HTTP://LINKED.DATA.GOV.AU/DATASET/ASGSED3/MB/11204701600",
                              "LGA_CODE_2021": "15990",
                              "LGA_NAME_2021": "NORTHERN BEACHES"
                          }
                      }
                  ]

                  

API Errors

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

Supplied identifier is invalid.

Call support to helpdesk to resolve this issue.

4071

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.

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 address auto complete calls

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.

Below example error code and message.
                    {
                      "errorCode": 4072,
                      "errorMessage": "search_word cannot be empty."
                    }
                  

Response Specification

Field Type Explanation Example
SOURCES

Array

Indicates data sources used to populate the record. Can contain any one or all three values:
• AU_GNAF – Geocoded National Address File
• AU_PAF – Australia Post Address File.
• LGA – Local Government data.

AU_PAF, LGA

Australia GNAF DATA
GNAF_ADDRESS_DETAIL_PID

String

Unique address identifier of GNAF dataset.

GANSW717343923

GNAF_BUILDING_NAME

String

Building name, if available

Super Towers

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

Flat type name.

UNIT

GNAF_FLAT_NUMBER_PREFIX

String

Flat number prefix if any

GNAF_FLAT_NUMBER

Integer

Flat number

12

GNAF_FLAT_NUMBER_SUFFIX

String

Flat number suffix if any

GNAF_LEVEL_TYPE

String

Floor Level type name

Level

GNAF_LEVEL_NUMBER_PREFIX

String

Floor Level number prefix, if any.

GNAF_LEVEL_NUMBER

Integer

Floor level number

GNAF_LEVEL_NUMBER_SUFFIX

String

Floor level number suffix, if any

GNAF_NUMBER_FIRST_PREFIX

String

Street number first prefix, if any.

GNAF_NUMBER_FIRST

Integer

Street number of the address.

1283

GNAF_NUMBER_FIRST_SUFFIX

String

Street Number suffix if any

A

GNAF_NUMBER_LAST_PREFIX

String

Street number last prefix, if any. This number prefix is for ranged addresses.

GNAF_NUMBER_LAST

Integer

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

1287

GNAF_NUMBER_LAST_SUFFIX

String

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

GNAF_STREET_LOCALITY_PID

String

Unique locality identifier.

NSW2940817

GNAF_STREET_NAME

String

Street name

PITTWATER

GNAF_STREET_TYPE_ABBR

String

Street type abbreviation.

RD

GNAF_STREET_SUFFIX_CODE

String

Street suffix code

GNAF_LOCALITY_NAME

String

Suburb/Locality name

NARRABEEN

GNAF_STATE_ABBREVIATION

String

Three letter state code.

NSW

GNAF_POSTCODE

String

Postal code of the suburb/locality.

2101

GNAF_LATITUDE

Float

Geographical latitude

-33.72153669

GNAF_LONGITUDE

Float

Geographical longitude

151.29792387

GNAF_GEOCODE_TYPE

String

Geocode type representing the type of Geocoding of the Latitude and Longitude.

PROPERTY CENTROID

GNAF_CONFIDENCE

Integer

Confidence level of geocode

2

GNAF_LEGAL_PARCEL_ID

String

Legal parcel identifier.

12/SP78412

GNAF_ADDRESS_MESH_BLOCK_2016_PID

String

2016 Australian Mesh block PID.

NSW1558501559

GNAF_MB_2016_PID

String

2016 MB PID

MB1611204701600

GNAF_MB_MATCH_CODE_2016

String

2016 MB match code

1

GNAF_MB_2016_CODE

String

2016 MB code

11204701600

GNAF_MBMC_2016_NAME

String

2016 MB MC code

PARCEL LEVEL MATCH

GNAF_ADDRESS_MESH_BLOCK_2021_PID

String

2021 Mesh block PID

NSW1571700942

GNAF_MB_2021_PID

String

2021 MB PID

MB2111204701600

GNAF_MB_MATCH_CODE_2021

String

2021 MB Match code

1

GNAF_MB_2021_CODE

String

2021 MB code

11204701600

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 1283-1287 PITTWATER RD NARRABEEN NSW 2101

COUNTRY_CODE

String

ISO two letter country code

AU

Australia Post Data
DELIVY_POINT_GROUP_ID

Integer

Australia Post Delivery point group identifier of the address.

387497

DELIVY_POINT_ID

Integer

Unique Delivery point identifier (DPID) of the address.

46360072

THOROUGHFARE_NBR_1

String

Street number

1283

THOROUGHFARE_NBR_SFX_1

String

Street number suffix if any

THOROUGHFARE_NBR_2

String

Street number last (only for addresses with ranged street numbers).

1287

THOROUGHFARE_NBR_SFX_2

String

Last street number (only for addresses with ranged street numbers) suffix, if any.

FLAT_UNIT_TYPE

String

Flat unit type, e.g. U - Unit, F - Flat etc.

U

FLAT_UNIT_NBR

String

Flat/Unit number of address for multi-dwelling buildings

12

FLOOR_LEVEL_TYPE

String

Floor level type of address for multi-floor/level buildings

FLOOR_LEVEL_NBR

String

Floor level type of unit for multi-floor/level buildings

LOT_NBR

String

LOT Number of the dwelling.

POSTAL_DELIVERY_NBR

String

Postal delivery number for address such as PO BOX

POSTAL_DELIVERY_NBR_PFX

String

Postal delivery number prefix for address such as PO BOX

POSTAL_DELIVERY_NBR_SFX

String

Postal delivery number suffix for address such as PO BOX

PRIMARY_POINT_IND

String

Indicator if the dwelling is Primary delivery point.

BLDG_PROP_NAME_1

String

Building/property name if any

BLDG_PROP_NAME_2

String

Building/property name continuation to BLDG_PROP_NAME_1

LOCALITY_ID

Integer

Unique locality/suburb identifier.

3435

STREET_NAME

String

Street name of the address.

PITTWATER

STREET_TYPE

String

Standardised street name abbreviation

RD

STREET_SFX

String

Street suffix, if any.

POSTAL_DELIVERY_TYPE

String

Indicates of the address is PO BOX or similar kind of address

DELIVY_POINT_GROUP_DID

Integer

Unique Delivery Point Group identifier.

LOCALITY_NAME

String

Locality/suburb name of the address.

NARRABEEN

POSTCODE

String

Post code of the suburb/locality.

2101

STATE

String

State abbreviation of the address.

NSW

LOCALITY_DID

Integer

Locality delivery identifier.

LOCALITY_NAME_SYNONYM

String

Locality/suburb name synonym, if any.

TYPE_ACTN_CODE

String

Record Type action code

ST_ALT_STREET_NAME

String

Alternate name of the street.

ST_ALT_STREET_TYPE

String

Alternate street type

ST_ALT_STREET_SFX

String

Alternate street suffix

BORDERING_LOCALITY_NAME

String

Comma separated bordering locality names of the address locality/suburb. These are returned as coma separated values.

INGLESIDE, CROMER, WHEELER HEIGHTS, COLLAROY, NORTH NARRABEEN, COLLAROY PLATEAU

BORDERING_POSTCODE

String

Comma separated bordering locality/suburb post codes corresponding to the Bordering locality names returned in the BORDERING_LOCALITY_NAME. These are returned as coma separated values.

2101, 2099, 2097, 2097, 2101, 2097

FULL_ADDRESS

String

Commonly used full address representation of the Australia Post matched address.

U 12 1283-1287 PITTWATER RD NARRABEEN NSW 2101

PAF_EXPIRY

Date

Australia Post mandated data expiry date pertaining to this record.

2023-06-31

COUNTRY_CODE

String

ISO two letter country code

AU

Local Government Data
LGA_MB_CODE_2021

String

2021 Mesh block code corresponding to Local government data.

11204701600

LGA_STATE_CODE_2021

String

2021 LGA code.

1

LGA_STATE_NAME_2021

String

State name as per Local government dataset.

NEW SOUTH WALES

LGA_AUS_CODE_2021

String

Three letter 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

Float

Local government area coverage in square kilometres.

0.0072

LGA_ASGI_LOCI_URI_2021

String

Local government area reference dataset URI.

HTTP://LINKED.DATA.GOV.AU/DATASET/ASGSED3/MB/11204701600

LGA_CODE_2021

String

2021 LGA code.

15990

LGA_NAME_2021

String

2021 Local government area name.

NORTHERN BEACHES

Get Postcode for Locality

API Documentation

Introduction

The Get postcode for locality retrieves the postcode for a given locality in a specific state

GET
https://api.addresser.com.au/postcode/getpostcodeforlocality

Example Usage

https://api.addresser.com.au/postcode/getpostcodeforlocality?locality=kellyville&state=nsw

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for either our 14-day free "Starter" or any other paid plans, via the "My Crendentials" section after logging into the "My Addresser" portal.

Parameter

Field Type Description
locality String

A valid locality from within Australia Post list of localities.

state String

A valid Australian state – three letter acronyms i.e. NSW,VIC, etc.

Success Response

The API's success response is LocalityPostcode, which consists of three elements: locality, state, and postcode.


{
    "LocalityPostcode": [
        {
            "Locality": "KELLYVILLE",
            "State": "NSW",
            "Postcode": "2155"
        }
    ],
    "Success": "True"
}

                  

API Errors

{
    "Response": "Invalid",
    "Comments": "The supplied locality & state combination is invalid.",
    "Success": "True"
}
                  
Error Code Description Resolution
4022

locality cannot be empty.

Input partial address into the locality query string of the request URL.

4023

locality is missing.

Parameter locality is missing.

4026

state cannot be empty

Input the partial address into the state query string of the request URL.

4027

states is missing.

Parameter state is missing.

5010

Internal Server Error.

 

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 address auto-complete calls.

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": 4077,
  "errorMessage": "Invalid Method or API URL."
}
                  

Response Specification

Field Type Description
Locality

String

The locality name or suburb name

State

String

Shows the locality of the state

Postcode

String

Shows postcode as Australia Post.

Success

boolean

Returns "True"/ "False" value based on the results of the API operation.

Get Locality for postcode

API Documentation

Introduction

The Get Locality for Postcode retrieves the list of all localities or suburbs for a given post code

GET
https://api.addresser.com.au/locality/getlocalityforpostcode

Example Usage

https://api.addresser.com.au/locality/getlocalityforpostcode?postcode=0852

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for either our 14-day free "Starter" or any other paid plans, via the "My Crendentials" section after logging into the "My Addresser" portal.

Parameter

Field Type Description
postcode String

A valid post code as per Australia post.

Success Response

The success response from the API consists of Suggestions array (Localities []) consisting of three elements – a locality, state and suburb.


{
    "Localities": [
        {
            "Locality": "HELEN SPRINGS STATION",
            "State": "NT",
            "Postcode": "0852"
        },
        {
            "Locality": "NUTWOOD DOWNS",
            "State": "NT",
            "Postcode": "0852"
        }
    ],
    "Success": "True"
}

                  

API Errors

{
    "errorCode": 4025,
    "errorMessage": "postcode is missing.",
    "success": "True"
}
                  
Error Code Description Resolution
4024

postcode cannot be empty.

Input partial address into the postcode query string of the request URL.

4025

postcode is missing.

parameter "postcode" is missing.

5010

Internal Server Error.

 

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 address auto-complete calls.

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": 4077,
  "errorMessage": "Invalid Method or API URL."
}
                  

Response Specification

Field Type Description
Locality

String

The locality name or suburb name

State

String

Shows the locality of the state

Postcode

String

Shows postcode as Australia Post.

Success

boolean

Returns "True"/ "False" value based on the results of the API operation.

Validate Locality Postcode

API Documentation

Introduction

The validatelocalitypostcode checks if the suburb/locality and supplied postcode combination is valid or not.

GET
https://api.addresser.com.au/locpos/validatelocalitypostcode

Example Usage

https://api.addresser.com.au/locpos/validatelocalitypostcode?postcode=2148&locality=BLACKTOWN

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for either our 14-day free "Starter" or any other paid plans, via the "My Crendentials" section after logging into the "My Addresser" portal.

Parameter

Field Type Description
postcode Integer

A valid post code as per Australia Post.

locality String

Locality/suburb name of the address

Success Response

The success response consists of three elements - Response, Comments and Success.


 { 

    "Response": "Valid", 

    "Comments": "The supplied locality & postcode combination is valid.", 

    "Success": "True" 

} 

                  

API Errors

{
    "errorCode": 4025,
    "errorMessage": "postcode is missing.",
    "success": "True"
}
                  
Error Code Description Resolution
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.

4022

locality cannot be empty.

Input partial address into the locality query string of the request URL.

4023

Locality is missing.

Parameter locality is missing.

4024

postcode cannot be empty.

Input partial address into the postcode query string of the request URL.

4025

postcode is missing.

Parameter postcode is missing.

5010

Internal Server Error.

 

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 address auto-complete calls.

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": 4077,
  "errorMessage": "Invalid Method or API URL."
}
                  

Response Specification

Field Type Description
Response

String

Valid or Invalid

Comments

String

The supplied locality & postcode combination is valid or invalid.

Success

Boolean

Returns "True"/ "False" value based on the results of the API operation.

Reverse GeoCode

API Documentation

Introduction

The API returns a possible list of geocoded addresses based on the distance from the closest latitude and longitude coordinates.

GET
https://api.addresser.com.au/reversegeocode

Example Usage

https://api.addresser.com.au/reversegeocode?latitude=-27.46267675&longitude=153.03032742&radius=1&search_word=12&limit=12

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for either our 14-day free "Starter" or any other paid plans, via the "My Crendentials" section after logging into the "My Addresser" portal.

Parameter

Field Type Description
latitude Float

The latitude coordinate to use in reverse geocode search.

longitude Float

The longitude coordinate to use in reverse geocode search.

radius Float

The distance limit from the given latitude and longitude. Can be any number starting from 0.1 to 10

search_word String

Text value to filter the search results based on string value within the resulting address list.

limit Integer

Maximum number of results to include in the search response. Can be any number starting from 10 to 20. and default value is 10.

Success Response

The success response from the API consists of Suggestions array consisting of three elements – a Full address, _id and source.


{
    "Suggestions": [
        {
            "FULL_ADDRESS": "U 1203 127 CHARLOTTE ST BRISBANE CITY QLD 4000",
            "_id": "h8z3ZI0BmbFDJ8B-HQ8g",
            "SOURCE": [
                "AU_PAF",
                "AU_GNAF",
                "LGA"
            ]
        },
        {
            "FULL_ADDRESS": "U 1207 128 CHARLOTTE ST BRISBANE CITY QLD 4000",
            "_id": "294AZY0BmbFDJ8B-1-jv",
            "SOURCE": [
                "AU_PAF",
                "AU_GNAF",
                "LGA"
            ]
        }
    ]
}

                  

API Errors

{
    "errorCode": 4094,
    "errorMessage": "longitude is missing/invalid."
}
                  
Error Code Description Resolution
4072

search_word cannot be empty.

Ensure that "search_word" is not empty for proper functionality.

4073

Supplied identifier is invalid.

The supplied identifier is invalid.

4090

Supplied radius is invalid.

The supplied radius is invalid.

4091

Supplied latitude is invalid.

The supplied latitude is invalid.

4092

Supplied longitude is invalid.

The supplied longitude is invalid.

4093

latitude is missing/invalid.

The latitude is missing/invalid.

4094

longitude is missing/invalid.

The longitude is missing/invalid.

5010

Internal Server Error.

 

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 address auto-complete calls.

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": 4077,
  "errorMessage": "Invalid Method or API URL."
}
                  

Response Specification

Field Type Description
FULL_ADDRESS

String

Single line and complete address of one suggestion returned.

_id

String

Addresser internal identifier.

SOURCE

String

Denoted the source from where the address information has been collated.