Addresser offers a range of APIs bundles on different subscription plans, but we want to make sure you have all the information you need to make the best decision for your business. Please note that some of our plans are no longer available for new subscribers, but we will continue to provide long-term support for all existing subscribers who have been using these plans.

The following plans are still fully supported:
1. Flat pricing – Basics
2. Flat pricing - Certified

Please be aware that as of March 28th, 2023, these plans will be decommissioned for new subscribers and replaced with the following:
3. eCommerce
4. Business

To help you understand the differences between these plans, we have provided a table below that lists the allowed APIs for each of the plans:

Plan API Name New Subscriptions
1. Flat pricing – Basics Autocomplete - Basic No
Metadata- Basic
2. Flat pricing - Certified Autocomplete - Certified No
Metadata- Certified
3. eCommerce Autocomplete - Certified Yes
Metadata- Certified
4. Business Autocomplete - Certified Yes
Metadata- Certified



Autocomplete - Basic

API Documentation

Introduction

The API provides capability to custom build your own auto complete functionality for desktop, web and mobile applications. Addresser Basic covers standard auto complete functionality based on Australian Government published Geocoded National Address File (GNAF).

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

HTTP over SSL

https://api.addresser.com.au/getautocompletebasic/basic

Please note: All endpoints are accessible to registered users only. You can visit the Pricing section of our home page to select 7-days free "eCommerce" or "Business" plan to register for trial account.

Addresser - Basic - Autocomplete

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/getautocompletebasic/basic
Example Usage
https://api.addresser.com.au/getautocompletebasic/basic?search_word=12

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for either our 7-days free "eCommerce" or "Business" plans, via the "My Crendentials" section after logging into the "My Addresser" portal.

You can visit the Pricing section of our home page to select 7-days free "eCommerce" or "Business" plan to register for trial account.

Parameter

Field Type Description
search_word String

Partial address searched for.
states optional String

Specific filter state codes to limit search to specific states or terrirories. Comma separated state codes should be used.

Usage

states=nsw,qld
states=nsw

https://api.addresser.com.au/getautocompletebasic/basic?search_word=12&states=nsw

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

Success 200

Field Type Description
Addresses (unnamed array ) String[]

Array of complete and formatted address strings

Sucess Response

[
              {
                "GNAF_FULL_ADDRESS": "U 12 1283-1287 PITTWATER RD NARRABEEN NSW 2101",
                "_id": "IR0mYoIBI7s5ZeO1Twrd"
              },
              {
                "GNAF_FULL_ADDRESS": "U 12 124-126 JOHN ST CABRAMATTA NSW 2166",
                "_id": "2GhjYoIBI7s5ZeO10fBz"
              },
              {
                "GNAF_FULL_ADDRESS": "U 12 1219-1225 PITTWATER RD COLLAROY NSW 2097",
                "_id": "_U1NYoIBI7s5ZeO1WndI"
              },
              {
                "GNAF_FULL_ADDRESS": "U 12 120-122 NEPEAN HWY ASPENDALE VIC 3195",
                "_id": "ZZyOYoIBI7s5ZeO1cNgp"
              },
              {
                "GNAF_FULL_ADDRESS": "U 12 1236-1244 CANTERBURY RD ROSELANDS NSW 2196",
                "_id": "UVJRYoIBI7s5ZeO1esCs"
              },
              {
                "GNAF_FULL_ADDRESS": "U 12 121-123 SWAN ST WANGARATTA VIC 3677",
                "_id": "G19cYoIBI7s5ZeO1B8qp"
              },
              {
                "GNAF_FULL_ADDRESS": "U 12 125-129 OAK RD KIRRAWEE NSW 2232",
                "_id": "tC81YoIBI7s5ZeO1JSqd"
              },
              {
                "GNAF_FULL_ADDRESS": "U 12 120-124 BEACH ST COOGEE NSW 2034",
                "_id": "2nxzYoIBI7s5ZeO1ZBcz"
              },
              {
                "GNAF_FULL_ADDRESS": "U 12 124-128 SPURWAY ST ERMINGTON NSW 2115",
                "_id": "M4h9YoIBI7s5ZeO1r-9Z"
              },
              {
                "GNAF_FULL_ADDRESS": "U 1204 123-125 MACQUARIE ST SYDNEY NSW 2000",
                "_id": "Aol9YoIBI7s5ZeO1vCyj"
              }
            ]

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 patial 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 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.
Below example error code and message. 
              {
                "errorCode": 4072,
                "errorMessage": "search_word cannot be empty."
              }

Response Specification

Field Type Explanation Example
FULL_ADDRESS

String

Full address response the input partial address

200 George St Sydney NSW 2000
_id

String

Unique record identifier of the address.

WZSHYoIBI7s5ZeO16aVH

Autocomplete - All

API Documentation

Introduction

The API provides capability to custom build your own auto complete functionality for desktop, web and mobile applications. Addresser Basic covers standard auto complete functionality based on both Australian Government published Geocoded National Address File (GNAF) and Australia Postal Address File.

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

HTTP over SSL

https://api.addresser.com.au/getautocomplete/all

Please note: All endpoints are accessible to registered users only. You can visit the Pricing section of our home page to select 7-days free "eCommerce" or "Business" plan to register for trial account.

Addresser - All - Autocomplete

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/getautocomplete/all

Example Usage

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

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for either our 7-days free "eCommerce" or "Business" plans, via the "My Crendentials" section after logging into the "My Addresser" portal.

You can visit the Pricing section of our home page to select 7-days free "eCommerce" or "Business" plan to register for trial account.

Parameter

Field Type Description
search_word String

Partial address searched for.
states optional String

Specific filter state codes to limit search to specific states or terrirories. Comma separated state codes should be used.

Usage

states=nsw,qld
states=nsw

https://api.addresser.com.au/getautocomplete/all?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
Western Australia - WA
Other Territories - OT

pdt String

Filter based on Post delivery types

"pdt=0" excludes PO Box type addresses
"pdt=1" includes PO Box type addresses.

Success 200

Field Type Description
Addresses (unnamed array ) String[]

Array of complete and formatted address strings

Sucess Response

[
                  {
                    "FULL_ADDRESS": "SHOP 12B 120-124 BIRKDALE RD BIRKDALE QLD 4159",
                    "_id": "WZSHYoIBI7s5ZeO16aVH"
                  },
                  {
                    "FULL_ADDRESS": "U 12 120-122 DUPORTH AVE MAROOCHYDORE QLD 4558",
                    "_id": "qMSuYoIBI7s5ZeO1MfML"
                  },
                  {
                    "FULL_ADDRESS": "SHOP 12A 120-124 BIRKDALE RD BIRKDALE QLD 4159",
                    "_id": "8NG6YoIBI7s5ZeO1Y-tH"
                  },
                  {
                    "FULL_ADDRESS": "U 12 123-125 BARBARALLA DR SPRINGWOOD QLD 4127",
                    "_id": "VHdvYoIBI7s5ZeO1j5tl"
                  },
                  {
                    "FULL_ADDRESS": "U 12 121-125 SURF PDE BROADBEACH QLD 4218",
                    "_id": "MNrAYoIBI7s5ZeO1pEeL"
                  },
                  {
                    "FULL_ADDRESS": "U 12 125-129 PAPPAS WAY CARRARA QLD 4211",
                    "_id": "M7ejYoIBI7s5ZeO1fdgS"
                  },
                  {
                    "FULL_ADDRESS": "U 12 121-123 JOHNSTON ST SOUTHPORT QLD 4215",
                    "_id": "WeT4YYIBI7s5ZeO1ew2E"
                  },
                  {
                    "FULL_ADDRESS": "U 12 125-127 TATE RD TOLGA QLD 4882",
                    "_id": "0AIRYoIBI7s5ZeO1JYak"
                  },
                  {
                    "FULL_ADDRESS": "U 12 120-122 QUEEN ST SOUTHPORT QLD 4215",
                    "_id": "wEtLYoIBI7s5ZeO1Z6uJ"
                  },
                  {
                    "FULL_ADDRESS": "SHOP 12 121-129 RUTHVEN ST HARLAXTON QLD 4350",
                    "_id": "qxMeYoIBI7s5ZeO1PIFg"
                  }
                  ]
                ]

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 patial 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 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.
Below example error code and message. 
                  {
                    "errorCode": 4072,
                    "errorMessage": "search_word cannot be empty."
                  }

Response Specification

Field Type Explanation Example
FULL_ADDRESS

String

Full address response the input partial address

200 George St Sydney NSW 2000
_id

String

Unique record identifier of the address.

WZSHYoIBI7s5ZeO16aVH

Metadata - Basic

API Documentation

Introduction

The API provides capability to access the basic metadata of selected address from the Addresser-Basic auto complete API

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

HTTP over SSL

https://api.addresser.com.au/getmetadatabasic/basic

Please note: All endpoints are accessible to registered users only. You can visit the Pricing section of our home page to select 7-days free "eCommerce" or "Business" plan to register for trial account.

Addresser - Basic - Metadata

Retrieves basic meta data for selected Address from the Autocomplete-Basic address match results.

GET 
https://api.addresser.com.au/getmetadatabasic/basic

Example Usage

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

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for either our 7-days free "eCommerce" or "Business" plans, via the "My Crendentials" section after logging into the "My Addresser" portal.

You can visit the Pricing section of our home page to select 7-days free "eCommerce" or "Business" plan to register for trial account.

Parameter

Field Type Description
_id String

Record identifier from the Autocomplete-Basic search results.

Success 200

Field Type Description
Metadata (unnamed array ) String[]

Metadata list in JSON format

Sucess Response

                    [
                    {
                      "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_NEW_DT_FLAT_NUMBER": "12",
                      "GNAF_PREFIX_NUMBER_FIRST": "1283",
                      "GNAF_PREFIX_NUMBER_LAST": "1287",
                      "GNAF_PREFIX_FLAT_NUMBER": "12",
                      "GNAF_PREFIX_LEVEL_NUMBER": null,
                      "GNAF_PREFIX_LOT_NUMBER_SUFFIX": null,
                      "GNAF_FULL_ADDRESS": "U 12 1283-1287 PITTWATER RD NARRABEEN NSW 2101",
                      "LGA_MB_CODE_2021": "11204701600",
                      "LGA_CODE_2021": "15990",
                      "LGA_NAME_2021": "NORTHERN BEACHES",
                      "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",
                      "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.
Below example error code and message. 
                    {
                      "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.

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

UNIT

GNAF_FLAT_NUMBER_PREFIX

String

Flat number prefix, if any

GNAF_FLAT_NUMBER

String

Flat number

11
GNAF_FLAT_NUMBER_SUFFIX

String

Flat number suffix, if any

a
GNAF_LEVEL_TYPE

String

Level type name

LEVEL
GNAF_LEVEL_NUMBER_PREFIX

String

Level number prefix, if any.

GNAF_NUMBER_FIRST_PREFIX

String

Street number first prefix, if any.

GNAF_NUMBER_FIRST

String

Street number of the address

120
GNAF_NUMBER_FIRST_SUFFIX

String

Street number first suffix, if any.

A
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.

124
GNAF_NUMBER_LAST_SUFFIX

String

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

B
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

State abbreviation

NSW
GNAF_POSTCODE

Number

Post code

NSW
GNAF_LATITUDE

Number

Latitude pertaining to the geolocation of the address.

-33.72153669
GNAF_LONGITUDE

Number

Longitute pertaining to the geolocation of the address.

151.29792387
GNAF_GEOCODE_TYPE

String

Geocode type.

PROPERTY CENTROID
GNAF_CONFIDENCE

Number

Confidence level of geocode

2
GNAF_LEGAL_PARCEL_ID

String

Legal parcel identifier.

12/SP78412
GNAF_ADDRESS_MESH_BLOCK_2016_PID

String

2016 Australian Meshblock 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_NEW_DT_FLAT_NUMBER

String

DT Flat Number

12
GNAF_PREFIX_NUMBER_FIRST

String

GNAF Number First Prefix

1283
GNAF_PREFIX_NUMBER_LAST

String

GNAF Number Last Prefix

1287
GNAF_PREFIX_FLAT_NUMBER

String

GNAF Flat Number

12
GNAF_PREFIX_LEVEL_NUMBER

String

GNAF Level Number Prefix

GNAF_PREFIX_LOT_NUMBER_SUFFIX

String

GNAF LOT Number Prefix and Suffix

GNAF_FULL_ADDRESS

String

Combined full address string based on GNAF data.

U 12 1283-1287 PITTWATER RD NARRABEEN NSW 2101
LGA_MB_CODE_2021

String

2021 Meshblock code corresponding to Local government data.

11204701600
LGA_CODE_2021

String

2021 LGA code.

15990
LGA_NAME_2021

String

2021 Local government area name.

NORTHERN BEACHES
LGA_STATE_CODE_2021

String

State code as per Local government dataset.

1
LGA_STATE_NAME_2021

String

State name as per Local government dataset.

NEW SOUTH WALES
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.075
LGA_ASGI_LOCI_URI_2021

String

Local government area reference dataset URI.

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

String

Source for the metadata returned by Addresser

AU_GNAF

Metadata - Certified

API Documentation

Introduction

The API provides capability to access the basic metadata of selected address from the Addresser-Certified auto complete API

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

HTTP over SSL

https://api.addresser.com.au/getmetadata/all

Please note: All endpoints are accessible to registered users only. You can visit the Pricing section of our home page to select 7-days free "eCommerce" or "Business" plan to register for trial account.

Addresser - Certified - Metadata

Retrieves all meta data for selected Address from the Autocomplete-certified address match results.

GET 
https://api.addresser.com.au/getmetadata/all

Example Usage

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

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key after registering for either our 7-days free "eCommerce" or "Business" plans, via the "My Crendentials" section after logging into the "My Addresser" portal.

You can visit the Pricing section of our home page to select 7-days free "eCommerce" or "Business" plan to register for trial account.

Parameter

Field Type Description
_id String

Record identifier from the Autocomplete-certified search results.

Success 200

Field Type Description
Metadata (unnamed array ) String[]

Metadata list in JSON format

Sucess Response

                    [
                    {
                      "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",
                      "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_NEW_DT_FLAT_NUMBER": "12",
                      "GNAF_PREFIX_NUMBER_FIRST": "1283",
                      "GNAF_PREFIX_NUMBER_LAST": "1287",
                      "GNAF_PREFIX_FLAT_NUMBER": "12",
                      "GNAF_PREFIX_LEVEL_NUMBER": null,
                      "GNAF_PREFIX_LOT_NUMBER_SUFFIX": null,
                      "GNAF_FULL_ADDRESS": "U 12 1283-1287 PITTWATER RD NARRABEEN NSW 2101",
                      "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",
                      "DATA_SOURCE": "AU_PAF & 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.
Below example error code and message. 
                    {
                      "errorCode": 4072,
                      "errorMessage": "search_word cannot be empty."
                    }

Response Specification

Field Type Explanation Example
DELIVY_POINT_GROUP_ID

Number

Australia Post Delivery point group identifier of the address.

387497
DELIVY_POINT_ID

Number

Unique Delivery point identifier 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.

XXX
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 buidlings

12
FLOOR_LEVEL_TYPE

String

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

FLOOR_LEVEL_NBR

String

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

2
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

Number

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

Number

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

Number

Locality delivery identifier.

LOCALITY_NAME_SYNONYM

String

Locality/suburb name synonym, if any.

TYPE_ACTN_CODE

String

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

Bordering locality names of the address locality/suburb. These are returned as comma separated values.

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

String

Bordering locality/suburb post codes corresponding to the Bordering locality names returned in the BORDERING_LOCALITY_NAME. These are returned as comma 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
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

UNIT

GNAF_FLAT_NUMBER_PREFIX

String

Flat number prefix, if any

GNAF_FLAT_NUMBER

String

Flat number

11
GNAF_FLAT_NUMBER_SUFFIX

String

Flat number suffix, if any

a
GNAF_LEVEL_TYPE

String

Level type name

LEVEL
GNAF_LEVEL_NUMBER_PREFIX

String

Level number prefix, if any.

GNAF_NUMBER_FIRST_PREFIX

String

Street number first prefix, if any.

GNAF_NUMBER_FIRST

String

Street number of the address

120
GNAF_NUMBER_FIRST_SUFFIX

String

Street number first suffix, if any.

A
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.

124
GNAF_NUMBER_LAST_SUFFIX

String

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

B
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

State abbreviation

NSW
GNAF_POSTCODE

Number

Post code

NSW
GNAF_LATITUDE

Number

Latitude pertaining to the geolocation of the address.

-33.72153669
GNAF_LONGITUDE

Number

Longitute pertaining to the geolocation of the address.

151.29792387
GNAF_GEOCODE_TYPE

String

Geocode type.

PROPERTY CENTROID
GNAF_CONFIDENCE

Number

Confidence level of geocode

2
GNAF_LEGAL_PARCEL_ID

String

Legal parcel identifier.

12/SP78412
GNAF_ADDRESS_MESH_BLOCK_2016_PID

String

2016 Australian Meshblock 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_NEW_DT_FLAT_NUMBER

String

DT Flat Number

12
GNAF_PREFIX_NUMBER_FIRST

String

GNAF Number First Prefix

1283
GNAF_PREFIX_NUMBER_LAST

String

GNAF Number Last Prefix

1287
GNAF_PREFIX_FLAT_NUMBER

String

GNAF Flat Number

12
GNAF_PREFIX_LEVEL_NUMBER

String

GNAF Level Number Prefix

GNAF_PREFIX_LOT_NUMBER_SUFFIX

String

GNAF LOT Number Prefix and Suffix

GNAF_FULL_ADDRESS

String

Combined full address string based on GNAF data.

U 12 1283-1287 PITTWATER RD NARRABEEN NSW 2101
LGA_MB_CODE_2021

String

2021 Meshblock code corresponding to Local government data.

11204701600
LGA_CODE_2021

String

2021 LGA code.

15990
LGA_NAME_2021

String

2021 Local government area name.

NORTHERN BEACHES
LGA_STATE_CODE_2021

String

State code as per Local government dataset.

1
LGA_STATE_NAME_2021

String

State name as per Local government dataset.

NEW SOUTH WALES
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.075
LGA_ASGI_LOCI_URI_2021

String

Local government area reference dataset URI.

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

String

Source for the metadata returned by Addresser

AU_GNAF

Address Validate

API Documentation

Introduction

This document provides guidance for developers to work with Addresser – Address Validate API offering from Addresser. It is expected the audience understand REST API and related technologies to use this guide.

AMAS (Address Matching Approval System) is an Australia Post-certification program used to measure the accuracy of address-matching software. AMAS confirms that our implementation of Address Validate conforms to:
• Correct the input and then match it to the Australia Post PAF.
• Append/Enhance the address with DPID (Delivery Point Identifier) to enable barcode generation for your mail if needed.

Address Validate

Address validate is a single real time API that can be used to validate one address at a time:

API Variant Data Features
Address Validate Enables developers to verify supplied full address against Australia Post Address File and returns matched address and all metadata. • Monthly Australia Post PAF updates for verification and metadata.
• GNAF dataset for all other metadata.

AUTHENTICATION

All Addresser APIs are secured with unique API keys that can be accessed from the Addresser Portal. You need to use the correct API Key. This guide assumes that the audience has already received the relevant API keys.

Addresser - Address Validate API

HTTP over SSL

The Address Validate API uses HTTP over SSL to secure client and server communications. Hence the URL needs to reflect the correct “HTTPS” use.
This API uses the POST method to receive address parameter that need to be validated. Example below:

Example Usage

POST 
https://api.addresser.com.au/addressvalidate/aupost

Body (Content-type: json)

 
      {
        "search_word": "U 605 7-9 CHURCHILL AVE STRATHFIELD NSW 2135"
      }

Request Headers

Field Type Description
x-api-key String

Your API key. You can access API Key via the "My Crendentials" section after logging into the "My Addresser" portal.

Parameter

Field Type Description
search_word String

The address that is being validated.
e.g. 17 George St Sydney NSW 2000.

Success 200

Field Type Description
unnamed array []

Data list in JSON format

Success Response

  [
    {
        "BARCODE_4STATE": "1301011112100120202100311013113303213",
        "BLDG_PROP_NAME_1": null,
        "BLDG_PROP_NAME_2": null,
        "BORDERING_LOCALITY_NAME": "BURWOOD, ENFIELD, HOMEBUSH WEST, STRATHFIELD SOUTH, HOMEBUSH, CONCORD, GREENACRE, NORTH STRATHFIELD, ROOKWOOD",
        "BORDERING_POSTCODE": "2134, 2136, 2140, 2136, 2140, 2137, 2190, 2137, 2141",
        "CORRECTIONS_APPLIED": "ExactMatch Rule - Valid no corrections applied",
        "DELIVY_POINT_GROUP_DID": null,
        "DELIVY_POINT_GROUP_ID": 402442,
        "DELIVY_POINT_ID": 45316670,
        "FLAT_UNIT_NBR": "605",
        "FLAT_UNIT_TYPE": "U",
        "FLOOR_LEVEL_NBR": null,
        "FLOOR_LEVEL_TYPE": null,
        "FULL_ADDRESS": "U 605 7-9 CHURCHILL AVE STRATHFIELD NSW 2135",
        "GNAF_ADDRESS_DETAIL_PID": "GANSW710971726",
        "GNAF_ADDRESS_MESH_BLOCK_2016_PID": "NSW1557667883",
        "GNAF_ADDRESS_MESH_BLOCK_2021_PID": "NSW1570858074",
        "GNAF_ALIAS_PRINCIPAL": "P",
        "GNAF_BUILDING_NAME": "",
        "GNAF_CONFIDENCE": 0,
        "GNAF_DATE_CREATED": "2008-01-05",
        "GNAF_FLAT_NUMBER": 605,
        "GNAF_FLAT_NUMBER_PREFIX": "",
        "GNAF_FLAT_NUMBER_SUFFIX": "",
        "GNAF_FLAT_TYPE": "UNIT",
        "GNAF_FULL_ADDRESS": "U 605 7-9 CHURCHILL AVE STRATHFIELD NSW 2135",
        "GNAF_FULL_ADD_W_PATTERN": "U 605 7-9 CHURCHILL AVE STRATHFIELD NSW 2135",
        "GNAF_GEOCODE_TYPE": "PROPERTY CENTROID",
        "GNAF_LATITUDE": -33.87209497,
        "GNAF_LEGAL_PARCEL_ID": "CP/SP64598",
        "GNAF_LEVEL_NUMBER": null,
        "GNAF_LEVEL_NUMBER_PREFIX": "",
        "GNAF_LEVEL_NUMBER_SUFFIX": "",
        "GNAF_LEVEL_TYPE": null,
        "GNAF_LOCALITY_NAME": "STRATHFIELD",
        "GNAF_LOCALITY_PID": "LOC337EE95AF1C9",
        "GNAF_LONGITUDE": 151.09293871,
        "GNAF_LOT_NUMBER": "",
        "GNAF_LOT_NUMBER_PREFIX": "",
        "GNAF_LOT_NUMBER_SUFFIX": "",
        "GNAF_MBMC_2016_NAME": "PARCEL LEVEL MATCH",
        "GNAF_MBMC_2021_NAME": "PARCEL LEVEL MATCH",
        "GNAF_MB_2016_CODE": "10714900000",
        "GNAF_MB_2016_PID": "MB1610714900000",
        "GNAF_MB_2021_CODE": "10714900000",
        "GNAF_MB_2021_PID": "MB2110714900000",
        "GNAF_MB_MATCH_CODE_2016": "1",
        "GNAF_MB_MATCH_CODE_2021": "1",
        "GNAF_NEW_DT_FLAT_NUMBER": "605",
        "GNAF_NEW_DT_LEVEL_NUMBER": null,
        "GNAF_NUMBER_FIRST": 7,
        "GNAF_NUMBER_FIRST_PREFIX": "",
        "GNAF_NUMBER_FIRST_STR": "7",
        "GNAF_NUMBER_FIRST_SUFFIX": "",
        "GNAF_NUMBER_LAST": 9,
        "GNAF_NUMBER_LAST_PREFIX": "",
        "GNAF_NUMBER_LAST_STR": "9",
        "GNAF_NUMBER_LAST_SUFFIX": "",
        "GNAF_POSTCODE": "2135",
        "GNAF_PREFIX_FLAT_NUMBER": "605",
        "GNAF_PREFIX_LEVEL_NUMBER": null,
        "GNAF_PREFIX_LOT_NUMBER_SUFFIX": null,
        "GNAF_PREFIX_NUMBER_FIRST": "7",
        "GNAF_PREFIX_NUMBER_LAST": "9",
        "GNAF_PRIMARY_SECONDARY": "S",
        "GNAF_STATE_ABBREVIATION": "NSW",
        "GNAF_STREET_LOCALITY_PID": "NSW2811248",
        "GNAF_STREET_NAME": "CHURCHILL",
        "GNAF_STREET_SUFFIX_CODE": null,
        "GNAF_STREET_TYPE_ABBR": "AV",
        "LGA_AREA_ALBERS_SQKM": 0.0015,
        "LGA_ASGI_LOCI_URI_2021": "HTTP://LINKED.DATA.GOV.AU/DATASET/ASGSED3/MB/10714900000",
        "LGA_AUS_CODE_2021": "AUS",
        "LGA_AUS_NAME_2021": "AUSTRALIA",
        "LGA_LGA_CODE_2021": "17100",
        "LGA_LGA_NAME_2021": "STRATHFIELD",
        "LGA_MB_CODE_2021": "10714900000",
        "LGA_STATE_CODE_2021": "1",
        "LGA_STATE_NAME_2021": "NEW SOUTH WALES",
        "LOCALITY_NAME": "STRATHFIELD",
        "LOCALITY_NAME_SYNONYM": null,
        "LOT_NBR": null,
        "PAF_EXPIRY": "2023-12-31",
        "PAF_VERSION": "V2023-32",
        "POSTAL_DELIVERY_NBR": null,
        "POSTAL_DELIVERY_NBR_PFX": null,
        "POSTAL_DELIVERY_NBR_SFX": null,
        "POSTAL_DELIVERY_TYPE": null,
        "POSTCODE": "2135",
        "RECORD_ACTN_CODE": "I",
        "STATE": "NSW",
        "STREET_NAME": "CHURCHILL",
        "STREET_SFX": null,
        "STREET_TYPE": "AVE",
        "ST_ALT_STREET_NAME": null,
        "ST_ALT_STREET_SFX": null,
        "ST_ALT_STREET_TYPE": null,
        "THOROUGHFARE_NBR_1": "7",
        "THOROUGHFARE_NBR_2": "9",
        "THOROUGHFARE_NBR_SFX_1": null,
        "THOROUGHFARE_NBR_SFX_2": null,
        "_id": "NdwOJokBL9KLoVDVrhFX"
    }
]

API Errors

      {
        "errorCode": xxxx,
        "errorMessage": "xxx"
      }
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.
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.
Below example error code and message. 
      {
        "errorCode": 4077,
        "errorMessage": "Invalid Method or API URL."
      }

Response Specification

Field Type Explanation Example
BARCODE_4STATE

String

BARCODE_4STATE is a number of 4 state barcode.

1301011112100120202100311013113303213
BLDG_PROP_NAME_1

String

Building/property name if any

null
BLDG_PROP_NAME_2

String

Building/property name continuation to BLDG_PROP_NAME_1

null
BORDERING_LOCALITY_NAME

String

Locality Name associated with the BORDERING_LOCALITY_ID

BURWOOD, ENFIELD, HOMEBUSH WEST, STRATHFIELD SOUTH, HOMEBUSH, CONCORD, GREENACRE, NORTH STRATHFIELD, ROOKWOOD
BORDERING_POSTCODE

String

Postcode associated with the BORDERING_LOCALITY_ID.

2134, 2136, 2140, 2136, 2140, 2137, 2190, 2137, 2141
CORRECTIONS_APPLIED

String

TBA

ExactMatch Rule - Valid no corrections applied
DELIVY_POINT_GROUP_DID

String

Unique Delivery ID for a delivery point group. Formed by adding 26,000,000 to the Delivy_Point_Group_ID

null
DELIVY_POINT_GROUP_ID

Integer

Australia Post Delivery point group identifier of the address.

402442
DELIVY_POINT_ID

Integer

Unique Delivery point identifier of the address.

45316670
FLAT_UNIT_NBR

String

Flat/Unit number of address for multi-dwelling buildings

605
FLAT_UNIT_TYPE

String

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

U
FLOOR_LEVEL_NBR

String

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

null
FLOOR_LEVEL_TYPE

String

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

null
FULL_ADDRESS

String

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

U 605 7-9 CHURCHILL AVE STRATHFIELD NSW 2135
GNAF_ADDRESS_DETAIL_PID

String

Unique address identifier of GNAF dataset.

GANSW710971726
GNAF_ADDRESS_MESH_BLOCK_2016_PID

String

2016 Australian Meshblock PID.

NSW1557667883
GNAF_ADDRESS_MESH_BLOCK_2021_PID

String

2021 Mesh block PID

NSW1570858074
GNAF_ALIAS_PRINCIPAL

String

Its represents Address Alials(A) or Principal(P)

P
GNAF_BUILDING_NAME

String

Building name, if available

 
GNAF_CONFIDENCE

Integer

Confidence level of geocode

0
GNAF_DATE_CREATED

String

Date this record was created

""2008-01-05""
GNAF_FLAT_NUMBER

Integer

Flat number

605
GNAF_FLAT_NUMBER_PREFIX

String

Flat number prefix, if any

 
GNAF_FLAT_NUMBER_SUFFIX

String

Flat number sufix, if any

 
GNAF_FLAT_TYPE

String

UNIT

UNIT
GNAF_FULL_ADDRESS

String

Combined full address string based on GNAF data.

U 605 7-9 CHURCHILL AVE STRATHFIELD NSW 2135
GNAF_FULL_ADD_W_PATTERN

String

Combined full address string based on GNAF and with respect to PAF Pattern

U 605 7-9 CHURCHILL AVE STRATHFIELD NSW 2135
GNAF_GEOCODE_TYPE

String

Geocode type.

PROPERTY CENTROID
GNAF_LATITUDE

Float

Latitude pertaining to the geolocation of the address.

-33.87209497
GNAF_LEGAL_PARCEL_ID

String

Legal parcel identifier

CP/SP64598
GNAF_LEVEL_NUMBER

String

Level number

null
GNAF_LEVEL_NUMBER_PREFIX

String

Level number prefix, if any.

 
GNAF_LEVEL_NUMBER_SUFFIX

String

Level number suffix, if any.

 
GNAF_LEVEL_TYPE

String

Level type name

null
GNAF_LOCALITY_NAME

String

Suburb/Locality name

STRATHFIELD
GNAF_LOCALITY_PID

String

The unique identifier for the locality

LOC337EE95AF1C9
GNAF_LONGITUDE

Float

Longitude pertaining to the geolocation of the address

151.09293871
GNAF_LOT_NUMBER

String

LOT number of the address provided by the GNAF dataset.

 
GNAF_LOT_NUMBER_PREFIX

String

Prefix of the LOT number

 
GNAF_LOT_NUMBER_SUFFIX

String

Suffix of the LOT number

 
GNAF_MBMC_2016_NAME

String

2016 MB MC code

PARCEL LEVEL MATCH
GNAF_MBMC_2021_NAME

String

2021 MB MC code

PARCEL LEVEL MATCH
GNAF_MB_2016_CODE

String

2016 MB code

10714900000
GNAF_MB_2016_PID

String

2016 MB PID

MB1610714900000
GNAF_MB_2021_CODE

String

2021 MB code

10714900000
GNAF_MB_2021_PID

String

2021 MB PID

MB2110714900000
GNAF_MB_MATCH_CODE_2016

String

2016 MB match code

1
GNAF_MB_MATCH_CODE_2021

String

2021 MB Match code

1
GNAF_NEW_DT_FLAT_NUMBER

String

DT Flat Number

605
GNAF_NEW_DT_LEVEL_NUMBER

String

DT Level number

null
GNAF_NUMBER_FIRST

Integer

The street number of the address

7
GNAF_NUMBER_FIRST_PREFIX

String

Street number first prefix, if any.

 
GNAF_NUMBER_FIRST_STR

String

The street number of the address

7
GNAF_NUMBER_FIRST_SUFFIX

String

Street number first suffix, if any

 
GNAF_NUMBER_LAST

Integer

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

9
GNAF_NUMBER_LAST_PREFIX

String

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

 
GNAF_NUMBER_LAST_STR

String

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

9
GNAF_NUMBER_LAST_SUFFIX

String

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

 
GNAF_POSTCODE

String

Post Code

2135
GNAF_PREFIX_FLAT_NUMBER

String

GNAF Flat Number

605
GNAF_PREFIX_LEVEL_NUMBER

String

GNAF Level Number Prefix

null
GNAF_PREFIX_LOT_NUMBER_SUFFIX

String

GNAF LOT Number Prefix and Suffix

null
GNAF_PREFIX_NUMBER_FIRST

String

GNAF Number First Prefix

7
GNAF_PREFIX_NUMBER_LAST

String

GNAF Number Last Prefix

9
GNAF_PRIMARY_SECONDARY

String

Persistent identifier for the primary address,Secondary persistent identifier for the Secondary address

S
GNAF_STATE_ABBREVIATION

String

State abbreviation

NSW
GNAF_STREET_LOCALITY_PID

String

Unique locality identifier

NSW2811248
GNAF_STREET_NAME

String

Street name

CHURCHILL
GNAF_STREET_SUFFIX_CODE

String

Street suffix code

null
GNAF_STREET_TYPE_ABBR

String

Street type abbreviation

AV
LGA_AREA_ALBERS_SQKM

Float

Local government area coverage in square kilometers

0.0015
LGA_ASGI_LOCI_URI_2021

String

Local government area reference dataset URI

HTTP://LINKED.DATA.GOV.AU/DATASET/ASGSED3/MB/10714900000
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_LGA_CODE_2021

String

2021 LGA code

17100
LGA_LGA_NAME_2021

String

2021 Local government area name

STRATHFIELD
LGA_MB_CODE_2021

String

2021 Meshblock code

10714900000
LGA_STATE_CODE_2021

String

State code as per Local government dataset

1
LGA_STATE_NAME_2021

String

State name as per Local government dataset

NEW SOUTH WALES
LOCALITY_NAME

String

Locality/suburb name of the address

STRATHFIELD
LOCALITY_NAME_SYNONYM

String

Locality/suburb name synonym, if any

null
LOT_NBR

String

LOT Number of the dwelling

null
PAF_EXPIRY

String

PAF Expiry Date

""2023-12-31""
PAF_VERSION

String

PAF Version

V2023-32
POSTAL_DELIVERY_NBR

String

The postal delivery number for the address such as PO BOX

null
POSTAL_DELIVERY_NBR_PFX

String

Postal delivery number prefix for address such as PO BOX

null
POSTAL_DELIVERY_NBR_SFX

String

Postal delivery number suffix for address such as PO BOX

null
POSTAL_DELIVERY_TYPE

String

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

null
POSTCODE

String

Postcode of the suburb/locality

2135
RECORD_ACTN_CODE

String

Action code identifies the action required for the record with each release of the PAF

I
STATE

String

State abbreviation of the address

NSW
STREET_NAME

String

The street name of the address

CHURCHILL
STREET_SFX

String

Street suffix, if any

null
STREET_TYPE

String

Standardized street name abbreviation

AVE
ST_ALT_STREET_NAME

String

Alternate name of the street.

null
ST_ALT_STREET_SFX

String

Alternate street suffix

null
ST_ALT_STREET_TYPE

String

Alternate street type

null
THOROUGHFARE_NBR_1

String

Street number

7
THOROUGHFARE_NBR_2

String

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

9
THOROUGHFARE_NBR_SFX_1

String

Street number suffix if any

null
THOROUGHFARE_NBR_SFX_2

String

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

null
_id

String

Addresser unique identifier

NdwOJokBL9KLoVDVrhFX