NZPost.AddressChecker

Resource URL

UAT:

http://api.uat.nzpost.co.nz/addresschecker/1.0/suggest_partial

Production:

https://api.nzpost.co.nz/addresschecker/1.0/suggest_partial

Resource Description

Takes an address fragment, and returns a set of partial addresses that match the fragment.

Resource Information

Attribute	Detail
Response Format	JSON
Requires Authentication	Yes
Rate Limited	15 calls per second. If rate limit is exceeded, calls will be queued. Calls unprocessed for over 60 seconds will time out.

Please note that all request parameters should be in lower case.

Request Parameters

Field Name	Description	Value	Required	Example
q	Partial Address fragment to query.	String	Yes	willis
max	Maximum number of results to return. (default: 10)	Integer	No	5

Sample Request

https://api.nzpost.co.nz/addresschecker/1.0/suggest_partial?q=willis&max=5

Response Parameters

Field Name	Description	Value	Required	Example
success	Indicates if the request succeeded or not.	Boolean	Yes	true
addresses	Contains array of address objects. The number of objects will not exceed the 'max' value defined.	Array	Yes if success = true	See Address Object below

Addresses Object

Field Name	Description	Value	Required	Example
UniqueId	Partial Address Unique Identifier	Integer	Yes	109570
FullPartial	Full partial address that might include suburb, town, city, postcode	String	Yes	Willis Street, Te Aro, Wellington 6011

Sample Response