Addressfinder

The best way to find exact addresses in New Zealand

  • Skip to Main Navigation
  • Skip to Footer Sitemap
  • Skip to Top
  • Pricing
  • Features
    • Autocomplete
      Search addresses and locations as you type
    • Bulk Cleansing
      Verify a database of addresses
    • Geocode Addresses
      Collect addresses and GPS coordinates together
    • Bounding Box
      Collect all addresses within a defined area
    • MORE FEATURES
  • About us
  • Case studies
  • FAQ
  • Contact
  • Blog
  • JavaScript widget docs
  • API developer docs
  • Pricing
  • Features
    • Autocomplete
      Search addresses and locations as you type
    • Bulk Cleansing
      Verify a database of addresses
    • Geocode Addresses
      Collect addresses and GPS coordinates together
    • Bounding Box
      Collect all addresses within a defined area
    • MORE FEATURES
  • More
    • Company & product
      • About Us
      • Case Studies
      • FAQ
      • Partners
      • Blog
      Contact Us
    • Integrations
      • Magento
      • WooCommerce
      • BigCommerce
      • Salesforce
      • Shopify Plus
      See all integrations
    • JavaScript widget docs
      • Integration Guide
      • Widget Code Generator
      • Widget Reference
      • Code Examples
      See all JavaScript docs
    • API developer docs
      • Address Autocomplete
      • Address Metadata
      • Address Verification
      • API Errors
      See all API docs
  • Login

Address Metadata API (AU)

  • Build
  • Send
  • Response
  • Errors

The Address Metadata API is used to load the full metadata associated with an address selected from the Address Autocomplete API.

Build the request URL

Use the form below to build your request URL from the available parameters. The URL string will be generated and can be sent to the API in order to provide insight into how the API works and the response it returns. Or, if you are using Postman for your investigation, development and testing, include the desired parameters and copy and paste the request URL below into Postman's GET request URL field.

Field Name Value Type Description
String Your unique licence key (find on Portal credentials)
String Your unique secret key (find on Portal credentials). Alternatively, you can pass your secret key into the Authorization header of the request as such: Authorization: your-secret
String The format of the response.
  • Options

    json json for a response in json format.

    xml xml for a response in xml format.

String Unique address id obtained from the Address Autocomplete API.

You must supply either an id, or a gnaf_id, or a dpid field.
String Unique id from the G-NAF dataset.

You must supply either an id, or a gnaf_id, or a dpid field.
String Australia Post delivery point identifier.

You must supply either an id, or a gnaf_id, or a dpid field.
String Used to determine which address database you will receive address and metadata from.
  • Options

    PAF 1 Returns postal address and metadata from the Australia Post PAF

    GNAF 0 Default - Returns physical address and metadata from the GNAF database and ABS

String Request GPS coordinates for latitude and longitude be returned when available
  • Options

    Yes 1 GPS coordinates wil be included in the response

    No 0

String Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. FAQ: learn more about the domain parameter
String Used to determine which census year’s statistical area identifiers (Meshblock, SA1 & SA2) will be returned in the response. Defaults to 2016 if omitted.
  • Options

    2016 2016 to collect 2016 census related metadata

    2021 2021 to collect 2021 census related metadata

* Parameters marked with an asterisk are mandatory for this API call.

Request URL

https://api.addressfinder.io/api/au/address/metadata/
      
        /* Click the button above to see a real API response here */
        {
          "success": true
        }
      
    

Response Specification

The API response will include all the attributes listed below in the format requested in the API request. Empty attributes for the matched address will be returned with a null value.

Key

GNAF Returned (if present) when searching the gnaf database.

PAF Returned (if present) when searching the paf database.

Field Name Type Description Example
full_address
GNAF PAF
String Full address string. FAQ: alias address vs canonical address. 13 Neville Street, RYDE NSW 2112
id
GNAF PAF
String The unique address identifier. This ID will change following a data refresh. 8097e3df-a3ab-43ad-bc66-22c8f5812361
canonical_address
GNAF PAF
String The canonical or official full address string associated with this address. Can differ from the full_address in either street number, locality name or state name. FAQ: alias address vs canonical address. 11-15 Neville Street, RYDE NSW 2112
canonical_address_id
GNAF PAF
String The ID of the canonical or official address associated with this search result.

Note: The ID and Canonical Address ID will be identical when the search result is canonical. FAQ: alias address vs canonical address.
d70230a9-a3d8-402f-971e-1b798d00f2f5
latitude
GNAF PAF
String Latitude coordinate (in WGS84 format). -37.899031
longitude
GNAF PAF
String Longitude coordinate (in WGS84 format). 144.999530
lot_identifier
GNAF PAF
String Identifies a specific lot on a site. Can be an alpha, number or a combination. 3
box_identifier
PAF
String The number portion of a PO Box address 123
box_type
PAF
String The type portion of a PO Box address, including PO Box, Locked Bag, GPO Box, CMB, RMS, Care PO, MS and RSD PO Box
site_name
GNAF PAF
String Holds the address element that identifies the name of a site or building. Kenilworth Police Station
level_type
GNAF PAF
String Describes the level type within a multi-level building. Basement
level_number
GNAF PAF
String Identifies a specific level within a multi-level building. Can be an alpha, number or a combination. 3
unit_type
GNAF PAF
String Describes the category of a sub-dwelling. Suite
unit_identifier
GNAF PAF
String Identifies a specific sub-dwelling. Can be an alpha, number or a combination. 2
street_number_1
GNAF PAF
String The number of the building on the street. 1703
street_number_2
GNAF PAF
String Holds the upper bound when this is a ranged address. For single number addresses this field is null 1705
street
GNAF PAF
String Holds the full name of the street. This attribute is a composite of the street name, the street type, and the street suffix if present. Queen Street North
street_name
GNAF PAF
String Holds the name of the street. Note: This attribute does not include the street type or suffix. Queen
street_type
GNAF PAF
String The type of street. Street
street_suffix
GNAF PAF
String The suffix of the street. Typically contains a compass direction. North
locality_name
GNAF PAF
String The locality/suburb of this address. KATOOMBA
state_territory
GNAF PAF
String The Australian state or territory where the address is located. NSW
postcode
GNAF PAF
String Holds the four digit postcode. 0983
address_line_1
GNAF PAF
String First line of the non-locality/state/postcode portion of the address Unit 209
address_line_2
GNAF PAF
String Second line of the non-locality/state/postcode portion of the address. This will be null for addresses without a unit/level/etc number. 274 Harbour Drive
success
GNAF PAF
Boolean Indicates if the request was successful or not. true
dpid
PAF
String Australia Post delivery point identifier. 99119187
lga_name
GNAF
String The name of the Local Government Area in which the address is located. These values are provided by the ABS and are an approximation of the gazetted local government boundaries.
Code example - collect LGA data
Bundaberg
lga_type_code
GNAF
String The code relating to the type (or status) of the Local Government Area. Codes used are Area A, Aboriginal Council AC, Borough B, City C, District Council DC, Municipality / Municipal Council M, Regional Council R or RegC, Rural City RC, Shire S and Town T. DC
legal_parcel_id
GNAF
String Government legal property description. 10//SP9489
meshblock
GNAF
String The meshblock identifier in which the address is located. These values are provided by the Australian Bureau of Statistics and are updated for each census.

The format is MB, followed by a 2 digit year identifier, followed by the 11 digit meshblock identifier.
MB1610671120000
sa1_id
GNAF
String The statistical area (SA1) identifier in which the address is located. These values are provided by the Australian Bureau of Statistics and are updated for each census. 12602159143
sa2_id
GNAF
String The statistical area (SA2) identifier in which the address is located. These values are provided by the Australian Bureau of Statistics and are updated for each census. 126021591
gnaf_id
GNAF
String The unique persistent identifier of the G-NAF address. GANSW705051429

Errors

Below are the possible errors that can be returned by the API.

  • Validation error (1000)
  • Key not found (1001)
  • Key not provided (1002)
  • Domain not registered with Addressfinder (1003)
  • Secret not provided (1004)
  • Direct API calls are not permitted on your current plan. (1005)
  • Invalid credentials (1006)
  • Secret should not be supplied (1008)
  • The Addressfinder plugin has exceeded the number of allowed lookups, and is now suspended (1009)
  • The record you are trying to load does not exist (1011)
  • Domain parameter must not be included in a web request (1015)
  • This domain has been blocked (1016)
  • This service is not enabled on your current plan (1017)
  • Your IP address has been blocked for these credentials (1018)
  • HTTP Referer or Origin header record must be present when making a browser initiated request (1019)
  • Your Addressfinder trial has ended (1020)
  • Your Addressfinder trial has exceeded its allowed lookups (1021)
  • Postal addresses are not enabled on your current plan (1022)
  • JavaScript Widget
    • Integration guide
    • Widget code generator
    • Code examples
    • Best practices
    • Fixing browser quirks
    • Advanced usage
    • Can't find your address?
    • JavaScript widget reference
  • Email Verification Services (ALPHA)
    • Email Verification API
    • Widget integration guide
    • Widget advanced usage
  • API Specs (NZ)
    • Address Autocomplete
    • Address Metadata
    • Address Verification
    • Address Reverse Geocode
    • Address Bounding Box
    • Location Autocomplete
    • Location Metadata
    • Points of Interest Autocomplete
    • Points of Interest Metadata
    • API Errors
  • API Specs (AU)
  • API Specs (INT'L)
  • Integrations
    • Magento
    • WooCommerce
    • BigCommerce
    • Salesforce
    • Shopify Plus
    • Hubspot
    • Spiffy Stores
    • Ruby
    • iOS
    • Drupal
    • Microsoft Dynamics 365
    • Vue
    • Gravity Forms
    • React
Addressfinder logo
Addressfinder provides speedy, accurate and dependable address autocompletion at a fair price. Easily integrate our address finder software with your site to start enjoying our address verification, address autocomplete and other address services today.

Sitemap

  • Home
  • About
  • Contact
  • Blog
  • FAQ
  • Pricing
  • Case Studies
  • Status Page
  • Privacy Policy
  • Terms & Conditions
  • Features
  • Address Metadata
  • Bulk Cleansing
  • Geocode Addresses
  • Reverse Address Lookup
  • Points of Interest
  • Street, Suburb & City Search
  • Bounding Box Search
  • Postcode Finder
  • Address Verification
  • Integrations
  • WooCommerce
  • BigCommerce
  • Shopify Plus
  • Magento
  • Salesforce
  • Spiffy Stores
  • iOS
  • Ruby
  • HubSpot
  • Drupal
  • Microsoft Dynamics 365
  • Vue
  • Gravity Forms
  • React
  • API Documentation
  • Address Autocomplete
  • Address Metadata
  • Address Verification
  • API Errors
  • Another 6 APIs
  • AU APIs specs
  • International APIs
  • Widget Documentation
  • Integration Guide
  • International Integration Guide
  • Code Generator
  • Code Examples
  • Javascript Reference
Addressfinder is also available in Australia
Terms and Conditions | Privacy
Copyright © 2022 Addressfinder, New Zealand