Skip to content
Address finder for websites to verify New Zealand addresses at the point of capture. Code samples are provided for fast and effective integration. Lightweight open source third party libraries are used for calling Addy’s free address finder API. Visit https://www.addy.co.nz/ for documentation and free address API access.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
address-autocomplete-single-line.html
address-checker-country.html
address-lookup-shipping.html
address-lookup-standard.html
addresslookup.png
addycomplete.css
addycomplete.js
addycomplete.min.css
addycomplete.min.js

README.md

Address lookup and verification made easy

https://www.addy.co.nz/

Create a delightful user experience and remove friction from your online forms, save customers time and increase your conversion rates.

Addresses are standardised at the point of capture, validated against official data sources including the New Zealand Postal Address File (PAF) and Land Information New Zealand (LINZ) database.

Avoid the unnecessary costs of failed deliveries, improve shipping efficiency and ensure parcels arrive first time.

Addy Address Autocomplete

Addy's address lookup use intelligent fuzzy matching for searching. This means that if a typo, invalid suburb or partially correct address is entered, customers can still find the right delivery or billing address.

Get Started

Create a free account https://www.addy.co.nz/signup to get an API key.

  1. Include addycomplete.min.css in your page, via the usual tags:
<link rel="stylesheet" href="addycomplete.min.css" />
  1. Include addycomplete.min.js at the bottom of the page, before closing the body tag:
<script src="addycomplete.min.js?key=YOUR-ADDY-KEY&callback=initAddy" async defer></script>

Replace YOUR-ADDY-KEY with your own Addy API Key.

Define the fields and options that will be called by the initAddy callback function once the script has loaded.

function initAddy() {
    var addyComplete = new AddyComplete(document.getElementById("address1"));
    addyComplete.fields = {
        address1: document.getElementById("address1"),
        address2: document.getElementById("address2"),
        suburb: document.getElementById("suburb"),
        city: document.getElementById("city"),
        postcode: document.getElementById("postcode")
    }
}

Live demo and documentation: https://www.addy.co.nz/address-finder-code-example

Prices

Addy's address finder is free of charge; download and install it at no cost. Just setup an account with Addy to get your 1,500 free completed address validations per month. If you require additional address lookups, simply pay as you go. See: https://www.addy.co.nz/pricing

Links

Official Addy site: https://www.addy.co.nz/

NZ Address Finder and Postcode API Documentation: https://www.addy.co.nz/address-finder-and-postcode-api

All Documentation: https://www.addy.co.nz/documentation

Frequently Asked Questions: https://www.addy.co.nz/frequently-asked-questions

License

The Address Checker code is released under the MIT License.

The reqwest library included in the bundle is released under the MIT License https://github.com/LeaVerou/awesomplete.

The Neat Complete library included in the bundle is released under the GNU Affero General Public License https://github.com/AbleTech/neat-complete.

You can’t perform that action at this time.