Geocoded National Address File

An Australian address from the Geocoded National Address File (G-NAF), published by Geoscape. Covers Australia and the external territories of Cocos (Keeling) Islands, Christmas Island and Norfolk Island.

Every attribute is always present. The API returns fields with no value as an empty string "".

The API returns attributes sourced from a one-to-many table (address aliases, site geocodes, locality aliases, street locality aliases) as a single comma separated string, with one element per related record. Related lists share an ordering, so the nth element of each describes the same record.

Example Record

Field	Example	Type
id	gnaf_GAQLD157509281|99	string
dataset	gnaf	string
country	Australia	string
country_iso	AUS	string
country_iso_2	AU	string
line_1	Flat 3 99 Barney St	string
line_2	Empty in this example	string
language	en	string
address	99	string
latitude	-23.85175973	number
longitude	151.27280546	number
address_detail_pid	GAQLD157509281	string
date_created	2015-07-22T00:00:00.000Z	string
date_last_modified	2021-07-07T00:00:00.000Z	string
date_retired	Empty in this example	string
building_name	Empty in this example	string
lot_number_prefix	Empty in this example	string
lot_number	1	string
lot_number_suffix	Empty in this example	string
flat_type_code	Flat	string
flat_number_prefix	Empty in this example	string
flat_number	3	number
flat_number_suffix	Empty in this example	string
level_type_code	Empty in this example	string
level_number_prefix	Empty in this example	string
level_number	Empty in this example	string
level_number_suffix	Empty in this example	string
number_first_prefix	Empty in this example	string
number_first	99	number
number_first_suffix	Empty in this example	string
number_last_prefix	Empty in this example	string
number_last	Empty in this example	string
number_last_suffix	Empty in this example	string
street_locality_pid	QLD106251	string
alias_principal	P	string
postcode	4680	string
private_street	Empty in this example	string
legal_parcel_id	1/RP611454	string
confidence	2	number
level_geocoded_code	7	number
primary_secondary	S	string
alias_type_code	Empty in this example	string
geocode_type_code	PC	string
default_latitude	-23.85175973	number
default_longitude	151.27280546	number
address_change_type_code	Empty in this example	string
mb_2016_match_code	1	string
mb_2021_match_code	1	string
address_type	UN	string
address_site_name	Empty in this example	string
geocode_site_name	Empty in this example	string
site_geocode_type_code	PC	string
reliability_code	2	string
site_boundary_extent	Empty in this example	string
site_planimetric_accuracy	Empty in this example	string
elevation	Empty in this example	string
site_longitude	151.27280546	string
site_latitude	-23.85175973	string
geocode_type_priority_order	14	number
site_geocode_priority_order	14	string
locality_name	Barney Point	string
primary_postcode	Empty in this example	string
locality_class_code	G	string
locality_gnaf_reliability_code	5	number
locality_alias_name	South Gladstone,Gladstone Harbour,Gladstone City,Gladstone	string
locality_alias_postcode	,,,	string
locality_alias_type_code	SYN,SYN,SYN,SYN	string
locality_planimetric_accuracy	Empty in this example	string
locality_latitude	-23.84320223	number
locality_longitude	151.26897733	number
mb_2016_code	30563058200	string
mb_2021_code	30563058200	string
ps_join_type_code	1	string
state_name	Queensland	string
state_abbreviation	QLD	string
street_class_code	C	string
street_name	Barney	string
street_type_code	Street	string
street_suffix_code	Empty in this example	string
gnaf_street_confidence	3	number
street_locality_gnaf_reliability_code	4	number
street_locality_alias_street_name	Empty in this example	string
street_locality_alias_street_type_code	Empty in this example	string
street_locality_alias_street_suffix_code	Empty in this example	string
street_locality_alias_type_code	Empty in this example	string
street_locality_boundary_extent	576	number
street_locality_planimetric_accuracy	Empty in this example	string
street_locality_latitude	-23.85114069	number
street_locality_longitude	151.27296937	number
street_type_name	St	string
street_locality_alias_street_type_name	Empty in this example	string

Every field is documented below.

Essential Elements

line_1 string

Address Line One

First address line. The building name where one is recorded, otherwise the street line.

Can be empty string "" if not present.

Example Flat 3 99 Barney St

line_2 string

Address Line Two

Second address line. The street line where line_1 carries a building name.

Can be empty string "" if not present.

Example Empty in this example

locality_name string

City

The name of the locality or suburb.

Example Barney Point

state_abbreviation string

State Abbreviation

The state or territory abbreviation.

Example QLD

postcode string

Postcode

Postcodes are optional as prescribed by AS4819 and AS4590:2006 5.13.

Example 4680

Address and Locality Details

address string

Address

Address / House Number uniquely identifying the address along the specified street. For a ranged address this is the number matched from the query, not the whole range.

Can be empty string "" if not present.

Example 99

building_name string

Building Name

Combines both building/property name fields. Field length: up to 200 alphanumeric characters (AS4590:2006 5.7).

Example Empty in this example

street_name string

Street Name

Street name. e.g. "Barney".

Example Barney

primary_postcode string

Primary Postcode

Required to differentiate localities of the same name within a state.

Example Empty in this example

private_street string

Private Street

Private street information. This is not broken up into name/type/suffix. Field length: up to 75 alphanumeric characters. This is not currently populated.

Example Empty in this example

address_site_name string

Address Site Name

Address site name. Field length: 200 alphanumeric characters.

Example Empty in this example

geocode_site_name string

Geocode Site Name

Comma separated identifiers relating to each geocoded site (e.g. "Transformer 75658"), one per site geocode record.

Example Empty in this example

street_locality_alias_street_name string

Street Locality Alias Street Name

Comma separated street alias names. e.g. "Poplar".

Example Empty in this example

Geographic and Location Information

country string

Country

Full country names (ISO 3166)

Example Australia

Enum

• "Australia"
• "Cocos (Keeling) Islands"
• "Christmas Island"
• "Norfolk Island"

country_iso string

Country ISO

3 letter country code (ISO 3166-1)

Example AUS

Enum

• "AUS"
• "CCK"
• "CXR"
• "NFK"

country_iso_2 string

Country ISO 2

2 letter country code (ISO 3166-1)

Example AU

Enum

• "AU"
• "CC"
• "CX"
• "NF"

longitude string

Longitude

Example 151.27280546

latitude string

Latitude

Example -23.85175973

default_longitude string | number

Default Longitude

Example 151.27280546

default_latitude string | number

Default Latitude

Example -23.85175973

site_longitude string

Site Longitude

Comma separated longitude of each site geocode (GDA2020).

Example 151.27280546

site_latitude string

Site Latitude

Comma separated latitude of each site geocode (GDA2020).

Example -23.85175973

locality_longitude string | number

Locality Longitude

Example 151.26897733

locality_latitude string | number

Locality Latitude

Example -23.84320223

street_locality_longitude string

Street Locality Longitude

Example 151.27296937

street_locality_latitude string | number

Street Locality Latitude

Example -23.85114069

Address Components and Identifiers

id string

ID

Example gnaf_GAQLD157509281|99

dataset string

Dataset

Example gnaf

Enum

• "gnaf"

address_detail_pid string

Address Detail PID

The Persistent Identifier is unique to the real world feature this record represents.

Example GAQLD157509281

street_locality_pid string

Street Locality PID

Identifier of the street locality this address sits on. Not mandatory - some G-NAF records do not require a street (e.g. a remote rural property).

Example QLD106251

legal_parcel_id string

Legal Parcel ID

Generic parcel id field derived from the Geoscape Australia's Cadastre parcel where available.

Example 1/RP611454

lot_number string

Lot Number

Lot number. Field length: up to five alphanumeric characters (AS4590:2006 5.8.1).

Example 1

lot_number_prefix string

Lot Number Prefix

Lot number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1).

Example Empty in this example

lot_number_suffix string

Lot Number Suffix

Lot number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1).

Example Empty in this example

flat_type_code string

Flat Type Code

Specification of the type of a separately identifiable portion within a building/complex. Field Length: up to seven upper case alpha characters (AS4590:2006 5.5.1.1).

Example Flat

flat_number string | integer

Flat Number

Example 3

flat_number_prefix string

Flat Number Prefix

Flat/unit number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2).

Example Empty in this example

flat_number_suffix string

Flat Number Suffix

Flat/unit number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2).

Example Empty in this example

level_type_code string

Level Type Code

Level type. Field length: up to four alphanumeric characters (AS4590:2006 5.5.2.1).

Example Empty in this example

level_number string | integer

Level Number

Example Empty in this example

level_number_prefix string

Level Number Prefix

Level number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2).

Example Empty in this example

level_number_suffix string

Level Number Suffix

Level number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2).

Example Empty in this example

number_first string | integer

Number First

Example 99

number_first_prefix string

Number First Prefix

Prefix for the first (or only) number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.1).

Example Empty in this example

number_first_suffix string

Number First Suffix

Suffix for the first (or only) number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.1).

Example Empty in this example

number_last string | integer

Number Last

Example Empty in this example

number_last_prefix string

Number Last Prefix

Prefix for the last number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.2).

Example Empty in this example

number_last_suffix string

Number Last Suffix

Suffix for the last number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.2).

Example Empty in this example

Date and Time Information

date_created string

Date Created

ISO 8601 date-time this record was created.

Format date-timeExample 2015-07-22T00:00:00.000Z

date_last_modified string

Date Last Modified

ISO 8601 date-time this record was last modified (not retired/recreated in line with ICSM standard).

Empty string "" if the record has never been modified.

Example 2021-07-07T00:00:00.000Z

date_retired string

Date Retired

ISO 8601 date-time this record was retired.

Empty string "" if the record is current.

Example Empty in this example

Geocode and Location Accuracy

confidence string | integer

Confidence

Example 2

level_geocoded_code integer

Level Geocoded Code

Binary indicator of the level of geocoding this address has. e.g. 0 = 000 = (No geocode), 1 = 001 = (No Locality geocode, No Street geocode, Address geocode), etc.

Example 7

geocode_type_code string

Geocode Type Code

Unique abbreviation for the geocode type of the default geocode.

Example PC

site_geocode_type_code string

Site Geocode Type Code

Comma separated abbreviations for each site geocode feature (e.g. "PRCL") (SAWG 7.4.1), one per site geocode record.

Example PC

geocode_type_priority_order string | integer

Geocode Type Priority Order

Example 14

site_geocode_priority_order string

Site Geocode Priority Order

Comma separated priority order of each site geocode type, 1 (most precise) to 29 (least precise), one per site geocode record.

Example 14

reliability_code string

Reliability Code

Comma separated spatial precision of each site geocode, expressed as a number in the range 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode).

Example 2

gnaf_street_confidence string | integer

G-NAF Street Confidence

Example 3

street_locality_gnaf_reliability_code string | integer

Street Locality G-NAF Reliability Code

Example 4

locality_gnaf_reliability_code string | integer

Locality G-NAF Reliability Code

Example 5

Miscellaneous Details

alias_principal string

Alias Principal

A = Alias record, P = Principal record.

Example P

alias_type_code string

Alias Type Code

Comma separated alias types for this address (e.g. "Synonym"), one per alias record.

Example Empty in this example

address_change_type_code string

Address Change Type Code

The code indicating the type of change, for example, LOC-STN for locality name and street name change.

Example Empty in this example

address_type string

Address Type

Address type (e.g. "Postal", "Physical").

Example UN

elevation string

Elevation

Comma separated elevation of each site geocode. This field is not currently populated.

Example Empty in this example

locality_alias_name string

Locality Alias Name

Comma separated alias names for the locality or suburb.

Example South Gladstone,Gladstone Harbour,Gladstone City,Gladstone

locality_alias_postcode string

Locality Alias Postcode

Comma separated postcodes, one per locality alias.

Example ,,,

locality_alias_type_code string

Locality Alias Type Code

Comma separated alias type codes, one per locality alias.

Example SYN,SYN,SYN,SYN

locality_class_code string

Locality Class Code

Describes the class of locality (e.g. Gazetted, topographic feature etc.). Lookup to locality class.

Example G

locality_planimetric_accuracy string | integer

Locality Planimetric Accuracy

Example Empty in this example

mb_2016_code string

MB 2016 Code

The 2016 mesh block code.

Example 30563058200

mb_2021_code string

MB 2021 Code

The 2021 mesh block code.

Example 30563058200

mb_2016_match_code string

MB 2016 Match Code

Code for the 2016 mesh block match e.g. 1.

Example 1

mb_2021_match_code string

MB 2021 Match Code

Code for the 2021 mesh block match e.g. 1.

Example 1

ps_join_type_code string

PS Join Type Code

Comma separated join type codes, one per primary/secondary link on this address. Each is 1 OR 2 when the root address:-

Code 1: Automatically generated when the primary and secondary addresses share the same street number, street name (and type) and locality name components.

Code 2: Manually generated where the primary and secondary addresses MAY or MAY NOT share the same street number, street name (and type) and locality name components

Example 1

primary_secondary string

Primary Secondary

Indicator that identifies if the address is P (Primary) or S (secondary).

Example S

site_boundary_extent string

Site Boundary Extent

Comma separated measurements (metres) of each site geocode from other geocodes associated with the same address persistent identifier.

Example Empty in this example

site_planimetric_accuracy string

Site Planimetric Accuracy

Comma separated planimetric accuracy of each site geocode.

Example Empty in this example

state_name string

State Name

The state or territory name, title cased. E.g. Tasmania.

Example Queensland

street_class_code string

Street Class Code

Defines whether this street represents a confirmed or unconfirmed street.

Example C

street_type_code string

Street Type Code

The street type code. e.g. "Street".

Example Street

street_suffix_code string

Street Suffix Code

The street suffix code. e.g. "West".

Example Empty in this example

street_locality_alias_street_type_code string

Street Locality Alias Street Type Code

Comma separated street type codes, one per street alias. e.g. "Place".

Example Empty in this example

street_locality_alias_street_suffix_code string

Street Locality Alias Street Suffix Code

Comma separated street suffix codes, one per street alias. e.g. "West".

Example Empty in this example

street_locality_alias_type_code string

Street Locality Alias Type Code

Comma separated alias type codes, one per street alias.

Example Empty in this example

street_locality_boundary_extent string | integer

Street Locality Boundary_Extent

Example 576

street_locality_planimetric_accuracy string | integer

Street Locality Planimetric Accuracy

Example Empty in this example

street_type_name string

Street Type Name

Abbreviation of the street type. e.g. "St".

Example St

street_locality_alias_street_type_name string

Street Locality Alias Street Type Name

Comma separated abbreviations of the street type, one per street alias. e.g. "St".

Example Empty in this example