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 Autocomplete API (AU)

  • Build
  • Send
  • Response
  • Errors

This page contains the technical API information for our Address Autocomplete service. Please visit our address autocomplete page if you are looking to learn more about the feature

This API is used to power the autocomplete capability of the widget. It can also be used to power your own custom autocomplete functionality, such as in a mobile or desktop app. If you want to call this API from a web browser, there are some special guidelines that you will need to follow.

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 partial address being searched.
String The format of the response.
  • Options

    json json for a response in json format.

    xml xml for a response in xml format.

String Returns physical addresses from the GNAF dataset (supplied by the Australian Government).
  • Options

    Physical 1 Returns physical addresses.

String Returns postal addresses from the PAF dataset. These are addresses which Australia Post deliver mail to and StarTrack and eParcel deliver parcels to.
  • Options

    Deliverable 1 Returns deliverable addresses.

String Return PO Box style addresses. This includes PO Box, Locked Bag, GPO Box, CMB, RMS, Care PO, MS and RSD. Used with the au_paf=1 filter above.
  • Options

    PO Boxes excluded 0 Set this option to exclude PO Box style addresses from your search results

    PO Boxes only 1 A rarely used option that returns only PO Box style addresses

    PO Boxes included Returns PO Box addresses with deliverable addresses

String Return canonical and/or alias addresses - this allows for vanity suburbs, historic street names, and more.

FAQ: What is the difference between canonical and alias addresses
  • Options

    Canonical only 1 Alias addresses are not included in the search results

    Any Canonical and alias addresses are returned (most common option)

String Filter the results according to the states or territories. Use a comma to separate multiple values
  • Options

    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

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
Integer The maximum number of results to return. A number between 1 and 100. The default is 10 results.
Integer Returns an additional attribute in the response called highlighted_a. This attribute wraps the matching terms in the address with <span class='af_hl'></span> in order to highlight those terms.
  • Options

    Highlighted 1 Matching terms in the returned addresses are highlighted. See the response specification for an example.

    No highlighting

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

Request URL

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

Response Specification

The API response will contain all the addresses and associated IDs (pxid) in the format requested in the API request.

Field Name Type Description Example
full_address
String Full address string. FAQ: alias address vs canonical address Unit 2, 21 Kent Road, DAPTO NSW 2530
canonical_address_id
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.
a4c4f26d-7327-40cc-9d05-ca94bd94a354
highlighted_full_address
String When highlighting is enabled, contains the full address string with highlighted matching terms. Unit <span class=‘af_hl’>2</span>, <span class=‘af_hl’>21</span> <span class=‘af_hl’>Kent</span> <span class=‘af_hl’>Road</span>, DAPTO NSW 2530
id
String The unique address identifier of the displayed address. As the displayed address can be an alias or canonical address, making use of the canonical_address_id is recommended. c10cf706-2e2e-4fe1-887c-156e6118ab76
success
Boolean Indicates if the request was successful or not. true

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