AddressFinder

The best way to find exact addresses in New Zealand

  • Skip to Main Navigation
  • Skip to Footer Sitemap
  • Skip to Top

Menu

Get Started Free

  • Pricing
  • Features & plugins
  • About us
  • Case studies
  • FAQ
  • Contact
  • Blog
  • JavaScript widget docs
  • API developer docs
  • Log in
  • Pricing
  • 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
      See all API docs
  • Log in
  • Get Started Free

Points of Interest Autocomplete API (NZ)

  • Build
  • Send
  • Response
  • Errors

This API call takes a partial name and various other optional parameters and returns a list of complete matching points of interest and their associated addresses.

Build the request URL

Use the form below to build your request URL from the parameters. A URL string will be generated from these parameters and sent to the API in order to provide insight into how the API works and the responses it returns.

Field Name Value Type Description
String Your unique licence key (find on Portal overview page)
String Your unique secret key (find on Portal overview page)
String The query string to be matched with the point of interest names and addresses.
String The required format of the response.
  • Options

    json json for a response in json format.

    xml xml for a response in xml format.

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

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

Request URL

        
          /* Click the button above to see a real API response here */
          {
            "success": true
          }
        
      

Response Specification

The API response will contain a hash with an element named completions, which is an array of hashes containing the following fields.

Field Name Type Description Example
name_and_address
String Point of interest name followed by its full address. Kenepuru Community Hospital, 16 Hospital Drive, Kenepuru, Porirua 5022
id
String The unique point of interest identifier. 1339
success
Boolean Indicates if the request was successful or not. true

Errors

Below are the possible errors that can be returned by the API.

Code Error Cause Resolution
1000
Validation error Returned when one of the supplied parameters is missing or incorrect. The response will contain a message attribute which explains the cause of the validation error. An example JSON response is shown below for a request which failed to include the q parameter.
{
completions: [ ],
message: 'Q can not be blank',
error_code: '1000'
}
Check that the supplied parameters contain valid values, and that the mandatory parameters have been included.
1001
Key not found Returned when the key included in your API call cannot be found in our database. This will normally happen when you make a copy ’n paste error. Compare the key included in your API call with the key listed in the AddressFinder Portal overview page.

Also confirm there are no additional spaces or characters in your API call.
1002
Key not provided Returned when you fail to send through your key with each request. The key is a mandatory parameter. Check that you are using the correct parameter name key.
1003
Domain not registered with AddressFinder Returned when you embed AddressFinder on a website that differs from the domain that you specified in the AddressFinder Portal. The AddressFinder Portal records the domains that are allowed to use your account.

Login to the AddressFinder Portal and add the domain of this website to your account.
1004
Secret not provided Returned when you fail to send through your secret with an API call.

Can also occur when using the widget and the HTTP Referer header is not included.
Include the secret listed in the AddressFinder Portal overview page in your API call.

When using the widget, you must load the page from a web server (e.g. localhost) and not a file:// scheme.
1005
Direct API calls are not permitted on your current plan. Returned if you try to call the API and you are on either a Free or Agile plan. These plan types provide access to the JavaScript Widget and plugins only. Upgrade to a Business plan. Visit the AddressFinder Portal to change plan.
1006
Invalid credentials Returned when the supplied key and/or secret value are incorrect. This will normally happen when you make a copy ’n paste error. Compare the key and secret included in your API call with the values listed on the AddressFinder Portal credentials page.

Also confirm there are no additional spaces or characters in your API call.
1008
Secret should not be supplied This is a safety check to ensure that the secret parameter has not been included when making requests from your web browser. You should never include the secret on any web page. The secret should be used for server-to-server API calls only.
1009
The AddressFinder plugin has exceeded the number of allowed lookups, and is now suspended Returned when your account (free plans only) has hit its 100% usage limit for the billing period. Visit the AddressFinder Portal and switch to a Paid plan.

Alternatively wait until the end of the month when suspended accounts are automatically reactivated.
1010
Account not authorised to use this API Returned when you make an API call that you are not permitted to use Contact AddressFinder support to request access to this API.
1011
The record you are trying to load does not exist Returned when the supplied address identifier cannot be found. This can happen when a stale identifier is included in the API call. Do not save address identifiers in your database, as they are transient and may change after each database update.
1012
Account not authorised to use this API Returned when you make an API call that you are not permitted to use Contact AddressFinder support to request access to this API.
1013
This API has been discontinued This API has been discontinued Contact AddressFinder support to discuss alternatives.
1014
Account Disabled Your account has been disabled by AddressFinder support. Contact AddressFinder support to discuss reactivating your account.
1015
Domain parameter must not be included in a web request You have included a domain parameter in your browser based API call. The domain parameter is for direct API calls only. Remove the domain parameter from your web request.
1016
This domain has been blocked These credentials are not permitted to be used on this domain. Contact AddressFinder support to discuss removing the block.
1017
This service is not enabled on your current plan You have attempted to use an AddressFinder service that is not enabled on your current plan. Visit the AddressFinder Portal to change plan.
1018
Your IP address has been blocked for these credentials This service has been configured to only allow access from defined IP addresses. Visit the AddressFinder Portal and add your IP address to the IP Allow List.
1019
HTTP Referer or Origin header record must be present when making a browser initiated request You have attempted to use the AddressFinder widget from a browser that does not include the referrer or orgin headers along with each request. Confirm that this request was sent from a valid web server (not the local filesystem), and that you do not have browser plugins interfering with the request.
1020
Your AddressFinder trial has ended Returned when the trial term has ended. Log into the AddressFinder Portal and upgrade your account to a suitable plan.
1021
Your AddressFinder trial has exceeded its allowed lookups. Returned when you have exceeded the number of lookups permitted on the trial plan. Log into the AddressFinder Portal and upgrade your account to a suitable plan.
  • JavaScript Widget
    • Integration guide
    • Widget code generator
    • Code examples
    • Best practices
    • Fixing browser quirks
    • Advanced usage
    • Can't find your address?
    • JavaScript widget reference
  • 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)
  • Integrations
    • Magento
    • WooCommerce
    • BigCommerce
    • Salesforce
    • Shopify Plus
    • Spiffy Stores
    • Ruby
    • iOS
    • Drupal
    • Microsoft Dynamics 365
    • Vue
    • Gravity Forms

Sitemap

Home

  • About
  • Contact
  • Blog
  • FAQ
  • Pricing
  • Case Studies
  • Status Page
  • Privacy Policy
  • Terms & Conditions

Features

  • Address Autocomplete
  • Address Verification
  • Address Metadata
  • Geocode Addresses
  • Reverse Geocode Addresses
  • Points of Interest
  • Street, Suburb & City Search
  • Bounding Box Search
  • Customer Portal

Integrations

  • WooCommerce
  • BigCommerce
  • Shopify Plus
  • Magento
  • Salesforce
  • Spiffy Stores
  • iOS
  • Ruby
  • Drupal
  • Microsoft Dynamics 365
  • Vue
  • Gravity Forms

API Documentation

  • Address Autocomplete
  • Address Metadata
  • Address Verification
  • API Errors
  • Another 6 APIs
  • AU APIs specs

Widget Documentation

  • Integration Guide
  • Code Generator
  • Code Examples
  • Javascript Reference

Get Started Free

AddressFinder is also available in Australia