JavaScript Widget docs

Embed the AffressFinder JavaScript Widget in your form to turn your address fields into an accurate address and/or location autocomplete field.

JavaScript widget code generator

Get a JavaScript code snippet to add to your form to convert your address field into an AddressFinder autocomplete field.

Integration Guide

Guided video, and step by step instructions for adding the AddressFinder widget to a custom web form.

Best practices

Our recommendations to get the best results from AddressFinder

Advanced usage

Tips for styling and enhancing AddressFinder

Code examples

Code examples for different ways you can use the JavaScript widget

JavaScript widget reference

Documentation describing the JavaScript Widget API.

API Developer docs

Use our powerful Address APIs to query the data and meta-data of New Zealand’s two million addresses.

Address Autocomplete API

Send an address fragment to this API, and receive back a list of matching addresses. Used by the AddressFinder widget to populate the autocomplete dropdown.

Uses of the Address Autocomplete API include:

• Windows applications used behind your firewall
• Mobile iOS or Android applications
• Embed within a Flash app

Address Verification API

Send an address that is poorly formatted or missing elements, and we will clean it up and return it will all the meta data including GPS coordinates.

Reverse Geocode API

Send a GPS coordinate to this API, and receive an ordered list of the closest addresses. Use this API in combination with your iOS or Android app to get an understanding of where your app is used.

Bounding Box API

Retrieve large sets of addresses based on a postcode, or a defined area on a map.

Example uses include:

• Displaying addresses on a Google Map
• Creating a custom mailout for a suburb or street
• Looking up the exact address for a property boundary

Address Metadata API

Use the unique identifier returned by the Address Autocomplete API, and receive detailed meta data about the selected address. This includes:

• Street name, Suburb, etc
• SOA compliant address records
• GPS coordinates
• Unique identifiers from LINZ for cross referencing
• Meshblock identifiers

Location APIs

Use our powerful Location APIs to query the data and meta-data of New Zealand's 75,000 streets, suburbs, cities and regions.

Location Autocomplete API

Similar to the Address Autocomplete API, this service returns any combination of Streets, Suburbs, Cities and Regions.

This API is useful for when you don't want exact addresses, but instead want a broader approximation of a location.

Location Metadata API

Use the unique identifier returned by the Location Autocomplete or Reverse Geocode API, and receive detailed meta data about the selected location. This includes:

• Street name, Suburb, etc
• GPS coordinates of centerpoint

Reverse Geocode Location API

Send a GPS coordinate to this API, and receive an ordered list of nearby streets, suburbs and cities. Use this API in combination with your iOS or Android app to get an understanding of where your app is used.

Troubleshooting

API Errors

If you’re getting an error back from the API, check here for a detailed explanation of what may be the problem.

Knowledge Base

Alternatively click on the Help button on the bottom right corner of this page to contact support. Suggest possible improvements and enhancements.