Skip to main content
G-NAF

Get a geocoded national address record (G-NAF)

Get an address detail record from the Geoscape Geocoded National Address File (G-NAF).

GET
/gnaf/{address_detail_pid}

Geoscape G-NAF is the geocoded address database for Australian businesses and governments. It's the trusted source of geocoded address data for Australia with over 50 million contributed addresses distilled into 15.4 million G-NAF addresses. It is built and maintained by Geoscape Australia using independently examined and validated government data.

G-NAF © Geoscape Australia licensed by the Commonwealth of Australia under the Open Geo-coded National Address File (G-NAF) End User Licence Agreement.

This method requires the GNAF:GetAddressRecord permission to be associated with your role

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

address_detail_pidstringrequired

Address Detail Id

Response

application/vnd.catch-e-api.v1+json

Success

address_detail_pidstring
Example: GAVIC424617164
address_mesh_block_2016_pidstring
Example: VIC1539415834
address_mesh_block_2021_pidstring
Example: VIC1583479526
building_namestring
confidencenumber
Example: 1
flat_numbernumber
Example: 4
flat_number_prefixstring
flat_number_suffixstring
flat_typestring
Example: UNIT
full_addressstring
Example: UNIT 4 2 FIVEWAYS BOULEVARDE KEYSBOROUGH VIC
geocode_typestring
Example: FRONTAGE CENTRE SETBACK
latitudenumber
Example: -37.9882384
legal_parcel_idstring
Example: 4PS441387
level_numbernumber
level_number_prefixstring
level_number_suffixstring
level_typestring
locality_namestring
Example: KEYSBOROUGH
longitudenumber
Example: 145.14579365
lot_numberstring
lot_number_prefixstring
lot_number_suffixstring
mb_2016_codestring
Example: 20233380000
mb_2016_pidstring
Example: MB1620233380000
mb_2021_codestring
Example: 20233380000
mb_2021_pidstring
Example: MB2120233380000
mb_match_code_2016string
Example: 1
mb_match_code_2021string
Example: 1
mbmc_2016_namestring
Example: PARCEL LEVEL MATCH
mbmc_2021_namestring
Example: PARCEL LEVEL MATCH
number_firstnumber
Example: 2
number_first_prefixstring
number_first_suffixstring
number_lastnumber
number_last_prefixstring
number_last_suffixstring
postcodestring
Example: 3173
state_abbreviationstring
Example: VIC
street_locality_pidstring
Example: VIC3465194
street_namestring
Example: FIVEWAYS
street_suffix_codestring
street_type_abbrstring
Example: BOULEVARDE

Still need help? Ask the team