addynz / nz-address-autocomplete

Address Autocomplete for New Zealand Addresses. Lightweight and simple code samples for calling a RESTful API, validating addresses against the NZ Postal Address File and LINZ databases, from a HTML and JavaScript address capture form.

This repository has been made obsolete. Use repository instead.

Addy's Address Autocomplete

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

Addy's Address Autocomplete will suggest New Zealand street addresses while you type.

This repository contains lightweight and simple code samples for calling the address finder API, validating addresses against the NZ Postal Address File (PAF) and LINZ databases, from a HTML and JavaScript address capture form.

Addy's service is using advanced fuzzy matching (See: https://www.addy.co.nz/address-finder-fuzzy-matching) to correct spelling mistakes.

Benefits

• Increase conversion rates with an improved checkout process
• Deliver to the right address, the first time
• Verify and validate address details in real-time

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" />

2. 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/nz-address-autocomplete-example

Awesomplete Extension

Addy's autocomplete code is based on the awesomplete https://github.com/LeaVerou/awesomplete (MIT License) widget by extending it to call Addy's NZ address finder API.

Prices

Addy's address autocomplete widget is free of charge; download and install it at no cost. Just setup an account with Addy. See: https://www.addy.co.nz/pricing

Links

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

RESTful Address Finder API Documentation: https://www.addy.co.nz/address-postcode-finder-integrations

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

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

License

The NZ-Address-Autocomplete code is released under the MIT License, which has the same license as awesomplete https://github.com/LeaVerou/awesomplete.