AddressFinder

The best way to find exact addresses in Australia

  • Skip to Main Navigation
  • Skip to Footer Sitemap
  • Skip to Top

Menu

Get Started Free

  • Pricing
  • Features & plugins
  • About us
  • Case studies
  • FAQ
  • Contact
  • Blog
  • JavaScript widget docs
  • API developer docs
  • Log in
  • Pricing
  • 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
      See all API docs
  • Log in
  • Get Started Free

Interactive Widget Code Generator

On the form below, select the options applicable to your addressing needs. Then copy the updated javascript, at the bottom, for use on your website / form

Create the code snippet

Get a licence key or, if you have one, login to the portal to get it.

Right click on your address field and click 'Inspect element'. The ID will look like: <input id="address_field">

  • This field determines which addresses are displayed. When either AU or NZ is selected we will only display addresses from that country.

    • An indicator to help determine if this address is located in a rural setting.

  • This search will return locations, rather than addresses. Locations include Streets, Suburbs, Cities and Regions. Eg. Ponsonby, Auckland. We do not recommend searching addresses and locations at the same time.

  • Use the device's GPS to suggest addresses at the current location.

  • This search will return locations, rather than addresses. Locations include Streets, Suburbs, States and Postcodes. Eg. DARLINGTON, NSW 2008. We do not recommend searching addresses and locations at the same time.

  • Options for collecting additional metadata

    Select additional metadata fields such as GPS coordinates, meshblock, etc

    • ABS meshblock ID is only returned when parameter gnaf=1 supplied. To enable this attribute, uncheck the 'only deliverable addresses' and 'include po boxes' boxes above.

    • GNAF address ID is only returned when parameter gnaf=1 supplied. To enable this attribute, uncheck the 'only deliverable addresses' and 'include po boxes' boxes above.

    • Australia Post DPID is only returned when parameter au_paf=1 supplied. To enable this attribute, check the 'only deliverable addresses' box above.

    • Legal Parcel ID is only returned when parameter gnaf=1 supplied. To enable this attribute, uncheck the 'only deliverable addresses' and 'include po boxes' boxes above.

    • Statistical Area 1 is only returned when parameter gnaf=1 supplied. To enable this attribute, uncheck the 'only deliverable addresses' and 'include po boxes' boxes above.

    • Statistical Area 2 is only returned when parameter gnaf=1 supplied. To enable this attribute, uncheck the 'only deliverable addresses' and 'include po boxes' boxes above.

  • Display options

    Configure the number of results returned, highlighting, etc

    • This option will only take effect when you upgrade to a paid plan.

Get the code

Copy and paste this code into the HTML of your website, directly above the closing </body> tag. Copy the code to your clipboard

            
          
Read the Integration Instructions

Frequently asked questions

  • What metadata fields can I collect with each address?

    The metadata fields available for collection vary according to the address that is being collected but can include:

    Field Name Description
    Canonical address as supplied by Land Information New Zealand or NZ Post.
    Associated postal address when supplied by NZ Post. Field will be omitted if this address is not delivered to by NZ Post. FAQ: postal address vs 'a' address.
    Holds the building or property name.
    Describes the category of a sub-dwelling.
    Identifies a specific sub dwelling. Can be alpha, number or a combination.
    The level number and level type in a multi-story building.
    The street number of the address. Also populated with the box number for PO Box type addresses.
    Holds the alpha component of a street number. In the address 1B High Street, B is the alpha.
    Holds the full name of the street. Note: The street attribute also includes the Street Type.
    Holds the name of the street.
    The type of street.
    The suburb or locality of the address as assigned by Land Information New Zealand.
    The city, town or locality name as assigned by Land Information New Zealand.
    The type of PO Box/CMB/Private Bag/Counter Delivery.
    The name of the NZ Post outlet or Agency outlet where the PO Box, Private Bag or Counter Delivery is located.
    The rural delivery number assigned by NZ Post to a rural address.
    Name of the suburb when supplied by NZ Post.
    Name of the town/city when supplied by NZ Post.
    Holds the four digit postcode.
    A unique reference number assigned to each delivery address by NZ Post.
    The unique identifier of the portion of land associated with the selected address.
    The unique identifier from Land Information New Zealand (LINZ).
    Longitude coordinate (in WGS84 format).
    Latitude coordinate (in WGS84 format).
    The meshblock identifier for the requested census dataset (see census parameter). If not specified, the Census parameter will default to 2018.
    Statistical area 1 (2018 census only)
    Statistical area 2 ID (2018 census only)
    Statistical area 2 name (2018 census only)
    An indicator to help determine if this address is located in a rural setting. Note: Different courier companies have different rural/urban boundaries so this determination should be confirmed by your delivery agent.
    Urban rural name (2018 census only)
    Urban rural ID (2018 census only)
    Urban rural indicator name (2018 census only)
    Urban rural indicator ID (2018 census only)
    The unique road section identifier from Land Information New Zealand (LINZ).
    The Regional Authority in which this address exists. Note: Regional Authorities are the top tier of local government in New Zealand.
    Region ID (2018 census only)
    The Territorial Authority in which this address exists. Territorial authorities are the second tier of local government in New Zealand.
    Territorial Authority ID (2018 census only)
    Constituency name (2018 census only)
    Constituency ID (2018 census only)
    Maori Constituency name (2018 census only)
    Maori Constituency ID (2018 census only)
    Ward name (2018 census only)
    Ward ID (2018 census only)
    Community Board name (2018 census only)
    Community Board ID (2018 census only)
    Territorial Authority Subdivision name (2018 census only)
    Territorial Authority Subdivision ID (2018 census only)
    Land/Water description (2018 census only)
    Land/Water ID (2018 census only)
    First line of the non-suburb/city/postcode portion of the address
    Second line of the non-suburb/city/postcode portion of the address.
    Unique address identifier.
    Indicates if the request was successful or not.
    Field Name Description
    Full address string. FAQ: alias address vs canonical address.
    The unique address identifier. This ID will change following a data refresh.
    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.
    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.
    Latitude coordinate (in WGS84 format).
    Longitude coordinate (in WGS84 format).
    Identifies a specific lot on a site. Can be an alpha, number or a combination.
    The number portion of a PO Box address
    The type portion of a PO Box address, including PO Box, Locked Bag, GPO Box, CMB, RMS, Care PO, MS and RSD
    Holds the address element that identifies the name of a site or building.
    Describes the level type within a multi-level building.
    Identifies a specific level within a multi-level building. Can be an alpha, number or a combination.
    Describes the category of a sub-dwelling.
    Identifies a specific sub-dwelling. Can be an alpha, number or a combination.
    The number of the building on the street.
    Holds the upper bound when this is a ranged address. For single number addresses this field is null
    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.
    Holds the name of the street. Note: This attribute does not include the street type or suffix.
    The type of street.
    The suffix of the street. Typically contains a compass direction.
    The locality/suburb of this address.
    The Australian state or territory where the address is located.
    Holds the four digit postcode.
    First line of the non-locality/state/postcode portion of the address
    Second line of the non-locality/state/postcode portion of the address. This will be null for addresses without a unit/level/etc number.
    Indicates if the request was successful or not.
    Australia Post delivery point identifier.
    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
    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.
    Government legal property description.
    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.

    Use the census parameter to select from either the 2011 and 2016 census. Defaults to 2016 if not provided.
    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.

    Use the census parameter to select from either the 2011 and 2016 census. Defaults to 2016 if not provided.
    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.

    Use the census parameter to select from either the 2011 and 2016 census. Defaults to 2016 if not provided.
    The unique persistent identifier of the G-NAF address.

    Metadata Fields for Australia

    Metadata fields for New Zealand

  • How do I collect the full address when I don’t have an ‘address_line_2’ field on my form?

    The AddressFinder widget is configured to populate the addresses elements into five fields (address line 1, address line 2, suburb, city, postcode) but not everyone has these fields on their form.

    If your form does not have an address line 2 then the widget can be adjusted to populate the data from address lines 1 and 2 into one field.

    Insert line 12 of this Code Example into your widget Javascript.

    The AddressFinder widget is configured to populate the addresses elements into five fields (address line 1, address line 2, suburb, state, postcode) but not everyone has these fields on their form.

    If your form does not have an address line 2 then the widget can be adjusted to populate the data from address lines 1 and 2 into one field.

    Insert lines 15 - 21 of this Code Example into your widget Javascript.

    The AddressFinder widget is configured to populate the addresses elements into five fields (address line 1, address line 2, suburb, state/city, postcode) but not everyone has these fields on their form.

    If your form does not have an address line 2 then the widget can be adjusted to populate the data from address lines 1 and 2 into one field.

    For New Zealand insert line 12 of this Code Example into your widget Javascript.

    For Australia insert lines 15 - 21 of this Code Example into your widget Javascript.

  • Can the region/state filters be used to include more than one region/state?

    No. The New Zealand widget "region_code" parameter can only be used to restrict address searches to one region

    Yes - you can enable the searching of more than one state/territory by adding the all of the desired State/Territory codes to your widget javascript. Make use of the code example below to add these codes.

    { address_params: {"state_codes": "QLD,NSW”} }
    Code State / Territory
    Australian Capital Territory
    New South Wales
    Northern Territory
    Other Territories
    Queensland
    South Australia
    Tasmania
    Victoria
    Western Australia

    Unfourtunately this is not possible with the New Zealand widget. The region_code parameter only works with one region code. { address_params: {"region_code": "1”} }

    This is possible with the Australian widget. You can add your desired State/Territory codes into the state codes address parameter: { address_params: {"state_codes": "QLD,NSW”} }

    Code State / Territory
    Australian Capital Territory
    New South Wales
    Northern Territory
    Other Territories
    Queensland
    South Australia
    Tasmania
    Victoria
    Western Australia
  • Can I search and collect different types of addresses from different places on my website?

    Yes - It is common to need to collect both a residential address and a postal address on the same form. To do this you will need to include the Javascript widget to your page twice and have each one configured for the specific address needs. See a code example here.

Sitemap

Home

  • About
  • Contact
  • Blog
  • FAQ
  • Pricing
  • Case Studies
  • Status Page
  • Privacy Policy
  • Terms & Conditions

Features

  • Australian Address Autocomplete
  • Australian Address Verification
  • Australian Address Metadata
  • Geocode Australian Addresses
  • Street, Suburb & City Search
  • Customer Portal

Integrations

  • WooCommerce
  • BigCommerce
  • Shopify Plus
  • Magento
  • Salesforce
  • Spiffy Stores
  • iOS
  • Ruby
  • Drupal
  • Microsoft Dynamics 365
  • Vue
  • Gravity Forms

API Documentation

  • Address Autocomplete
  • Address Metadata
  • Address Verification
  • API Errors
  • Another 2 APIs
  • NZ API specs

Widget Documentation

  • Integration Guide
  • Code Generator
  • Code Examples
  • Javascript Reference

Get Started Free

AddressFinder is also available in New Zealand