Addressfinder

The best way to find exact addresses in New Zealand

  • Skip to Main Navigation
  • Skip to Footer Sitemap
  • Skip to Top
  • Pricing
  • Features
    • Autocomplete
      Search addresses and locations as you type
    • Bulk Cleansing
      Verify a database of addresses
    • Geocode Addresses
      Collect addresses and GPS coordinates together
    • Bounding Box
      Collect all addresses within a defined area
    • MORE FEATURES
  • About us
  • Case studies
  • FAQ
  • Contact
  • Blog
  • JavaScript widget docs
  • API developer docs
  • Pricing
  • Features
    • Autocomplete
      Search addresses and locations as you type
    • Bulk Cleansing
      Verify a database of addresses
    • Geocode Addresses
      Collect addresses and GPS coordinates together
    • Bounding Box
      Collect all addresses within a defined area
    • MORE 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
      • API Errors
      See all API docs
  • Login

Points of Interest Metadata API (NZ)

  • Build
  • Send
  • Response
  • Errors

This API call takes a point of interest identifier, and returns detailed information about that point of interest.

Build the request URL

Use the form below to build your request URL from the available parameters. The URL string will be generated and can be sent to the API in order to provide insight into how the API works and the response it returns. Or, if you are using Postman for your investigation, development and testing, include the desired parameters and copy and paste the request URL below into Postman's GET request URL field.

Field Name Value Type Description
String Your unique licence key (find on Portal credentials)
String Your unique secret key (find on Portal credentials). Alternatively, you can pass your secret key into the Authorization header of the request as such: Authorization: your-secret
String The format of the response.
  • Options

    json json for a response in json format.

    xml xml for a response in xml format.

String Unique address id obtained from the Points of Interest Autocomplete API.
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

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

Request URL

https://api.addressfinder.io/api/nz/points_of_interest/metadata/
      
        /* Click the button above to see a real API response here */
        {
          "success": true
        }
      
    

Response Specification

The API response will contain all the addresses and associated IDs (pxid) in the format requested in the API request.

Field Name Type Description Example
name
String The name of the point of interest Whangarei Hospital
pxid
String Unique point of interest identifier. 3-.1.1d.2.42.1T.2
a
String Canonical address as supplied by Land Information New Zealand or NZ Post. Unit 2, 1703A State Highway 1, Warkworth 0983
postal
String Associated postal address when supplied by NZ Post. Field will be omitted if this address is not delivered to by NZ Post. FAQ: postal address vs 'a' address. Unit 2, 1703A State Highway 1, RD 3, Warkworth 0983
number
String The street number of the address. Also populated with the box number for PO Box type addresses. 1703
alpha
String Holds the alpha component of a street number. In the address 1B High Street, B is the alpha. B
unit_identifier
String Identifies a specific sub dwelling. Can be alpha, number or a combination. 1
unit_type
String Describes the category of a sub-dwelling. flat
floor
String The level number and level type in a multi-story building. Level 19
street
String Holds the full name of the street. Note: The street attribute also includes the Street Type. State Highway 1
street_type
String The type of street. avenue
building_name
String Holds the building or property name. Miban Building
suburb
String The suburb or locality of the address as assigned by Land Information New Zealand. Warkworth
post_suburb
String Name of the suburb when supplied by NZ Post. Manukau
city
String The city, town or locality name as assigned by Land Information New Zealand. Warkworth
mailtown
String Name of the town/city when supplied by NZ Post. Warkworth
ta
String The Territorial Authority in which this address exists. Territorial authorities are the second tier of local government in New Zealand. Auckland
region
String The Regional Authority in which this address exists. Note: Regional Authorities are the top tier of local government in New Zealand. Auckland Region
rd_number
String The rural delivery number assigned by NZ Post to a rural address. 4
postcode
String Holds the four digit postcode. 0983
meshblock
String The meshblock identifier for the requested census dataset (see census parameter). If not specified, the Census parameter will default to 2018. 146004
address_pxid
String Address identifier for the address of this point of interest. 2-.F.11.8.G.4
aims_address_id
Integer The unique identifier from Land Information New Zealand (LINZ). 103524
dpid
String A unique reference number assigned to each delivery address by NZ Post. 2668726
box_type
String The type of PO Box/CMB/Private Bag/Counter Delivery. PO Box
lobby_name
String The name of the NZ Post outlet or Agency outlet where the PO Box, Private Bag or Counter Delivery is located. Fendalton
x
String Longitude coordinate (in WGS84 format). 174.643199
y
String Latitude coordinate (in WGS84 format). -36.426956
success
Boolean Indicates if the request was successful or not. true

Errors

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

  • Validation error (1000)
  • Key not found (1001)
  • Key not provided (1002)
  • Domain not registered with Addressfinder (1003)
  • Secret not provided (1004)
  • Direct API calls are not permitted on your current plan. (1005)
  • Invalid credentials (1006)
  • Secret should not be supplied (1008)
  • The Addressfinder plugin has exceeded the number of allowed lookups, and is now suspended (1009)
  • The record you are trying to load does not exist (1011)
  • Domain parameter must not be included in a web request (1015)
  • This domain has been blocked (1016)
  • This service is not enabled on your current plan (1017)
  • Your IP address has been blocked for these credentials (1018)
  • HTTP Referer or Origin header record must be present when making a browser initiated request (1019)
  • Your Addressfinder trial has ended (1020)
  • Your Addressfinder trial has exceeded its allowed lookups (1021)
  • Postal addresses are not enabled on your current plan (1022)
  • JavaScript Widget
    • Integration guide
    • Widget code generator
    • Code examples
    • Best practices
    • Fixing browser quirks
    • Advanced usage
    • Can't find your address?
    • JavaScript widget reference
  • Email Verification Services (ALPHA)
    • Email Verification API
    • Widget integration guide
    • Widget advanced usage
  • 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)
  • API Specs (INT'L)
  • Integrations
    • Magento
    • WooCommerce
    • BigCommerce
    • Salesforce
    • Shopify Plus
    • Hubspot
    • Spiffy Stores
    • Ruby
    • iOS
    • Drupal
    • Microsoft Dynamics 365
    • Vue
    • Gravity Forms
    • React
Addressfinder logo
Addressfinder provides speedy, accurate and dependable address autocompletion at a fair price. Easily integrate our address finder software with your site to start enjoying our address verification, address autocomplete and other address services today.

Sitemap

  • Home
  • About
  • Contact
  • Blog
  • FAQ
  • Pricing
  • Case Studies
  • Status Page
  • Privacy Policy
  • Terms & Conditions
  • Features
  • Address Metadata
  • Bulk Cleansing
  • Geocode Addresses
  • Reverse Address Lookup
  • Points of Interest
  • Street, Suburb & City Search
  • Bounding Box Search
  • Postcode Finder
  • Address Verification
  • Integrations
  • WooCommerce
  • BigCommerce
  • Shopify Plus
  • Magento
  • Salesforce
  • Spiffy Stores
  • iOS
  • Ruby
  • HubSpot
  • Drupal
  • Microsoft Dynamics 365
  • Vue
  • Gravity Forms
  • React
  • API Documentation
  • Address Autocomplete
  • Address Metadata
  • Address Verification
  • API Errors
  • Another 6 APIs
  • AU APIs specs
  • International APIs
  • Widget Documentation
  • Integration Guide
  • International Integration Guide
  • Code Generator
  • Code Examples
  • Javascript Reference
Addressfinder is also available in Australia
Terms and Conditions | Privacy
Copyright © 2022 Addressfinder, New Zealand