https://github.com/addynz/address-lookup
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.addysolutions.com/ for documentation and free address API access.
https://github.com/addynz/address-lookup
address address-autocomplete address-finder address-lookup address-verification addressfinder addy autocomplete lookup new-zealand nz-postal-address postcode-lookup-service postcode-validation validation verification
Last synced: 4 months ago
JSON representation
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.addysolutions.com/ for documentation and free address API access.
- Host: GitHub
- URL: https://github.com/addynz/address-lookup
- Owner: addynz
- License: mit
- Created: 2017-11-18T04:38:57.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-12T20:06:08.000Z (6 months ago)
- Last Synced: 2025-05-18T09:11:29.326Z (5 months ago)
- Topics: address, address-autocomplete, address-finder, address-lookup, address-verification, addressfinder, addy, autocomplete, lookup, new-zealand, nz-postal-address, postcode-lookup-service, postcode-validation, validation, verification
- Language: JavaScript
- Homepage:
- Size: 173 KB
- Stars: 5
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Address lookup and verification made easy
https://www.addysolution.com/
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'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 to get an API key.
1) Include addycomplete.min.css in your page, via the usual tags:
```html
```
2) Include addy.min.js at the bottom of the page, before closing the body tag:
```html
```
Replace YOUR-ADDY-KEY with your own Addy API Key. (for AU country, use 'auKey' instead 'nzKey' and 'country=au')
Define the fields and options that will be called by the initAddy callback function once the script has loaded.
```javascript
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:
## Prices
Visit the pricing page for more information and to find a plan that works for your business (https://www.addysolutions.com/pricing).
## Links
Official Addy site:
NZ Address Finder and Postcode API Documentation:
All Documentation:
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 .
The Neat Complete library included in the bundle is released under the GNU Affero General Public License .