addy

NZ
AU

addy

NZ
AU

Services

Pricing

Documentation

Contact

FAQ

Login

Address APIs

Address Finder API
Address Validation API
Address Details API
Address Discovery API
Postcode Finder API
Geocode Address API
Bounding Box API

Address Details API

Use the Address Details API to retrieve address metadata by ID , DPID or LINZ ID

Overview


Given an unique address identifier, such as Addy's Address ID, NZ Post's Delivery Point Identifier (DPID) or LINZ's Street Address ID, the Address Details API will return a list of properties / metadata about that address.

Vist the address validation page for a live address search demo that returns all address metadata.

500 FREE completed address fields per month. Busy month? Choose a plan to meet your needs.

API Endpoint


URLDescription
https://api-nz.addysolutions.com/address/{id}Retrieve an address using Addy's Address ID (e.g. the "id" property from the address finder API).
https://api-nz.addysolutions.com/address?type=addyid&id={id}Retrieve an address using Addy's Address ID (e.g. the "id" property from the address finder API).
https://api-nz.addysolutions.com/address?type=dpid&id={id}Retrieve an address using NZ Post's Delivery Point Identifier (DPID).
https://api-nz.addysolutions.com/address?type=linzid&id={id}Retrieve an address using LINZ's Street Address ID (street_id).

cURL Request


The example below will make a JSON request to retrieve the address ID 2417575 by adding the API key in the request header:

1curl -X GET --header 'Accept: application/json' --header 'addy-api-key: demo-api-key' 'https://api-nz.addysolutions.com//address/2417575'
Remember to replace demo-api-key with your own API key.

Lookup address "2417575" using the API key as a query string parameter:

1curl -X GET --header 'Accept: application/json' 'https://api-nz.addysolutions.com/address/2417575?key=demo-api-key'
Remember to replace demo-api-key with your own API key.

Request Parameters


Request by Path
ParameterDescriptionTypeRequiredExample
{id}Address Identifier (see the "id" field in the address finder API response)pathYeshttps://api-nz.addysolutions.com/address/2417575
Request Parameters by Type
ParameterDescriptionTypeRequiredExample
{type}The type of identifier (addyid, dpid or linzid)querystringYeshttps://api-nz.addysolutions.com/address?type=addyid&id=2417575
{id}Address Identifier based on the type parameterquerystringYeshttps://api-nz.addysolutions.com/address?type=addyid&id=2417575

Address Metadata


PropertyDescriptionTypeExample
idUnique Addy identifierinteger2417575
dpidUnique NZ Post identifier. This property can be null for a non-mail deliverable addressinteger1540203
linzidUnique Land Information New Zealand (LINZ) identifierinteger2027703
parcelidLand Information New Zealand (LINZ) parcel identifier (NZ Parcels)integer6917300
meshblockUnique Statistics New Zealand (Stats NZ) identifier to match census datainteger438102
numberStreet number. Street number will be "80" in case of "80A Queen Street"integer80
numberfullStreet number with a short unit prefix or suffixstring2/80
numberdisplayStreet number with a long unit prefix or suffixstringFlat 2, 80
rdnumberRural delivery number (postal only) for rural addressesstring (max 10)33
alphaStreet alpha e.g. "A" in the case of "80A Queen Street"string (max 20)A
unittypeType of unit e.g. "FLAT" in "FLAT 3, 80 Queen Street"string (max 20)FLAT
unitnumberUnit number e.g. "3" in "FLAT 3, 80 Queen Street"string (max 20)3
floorFloor number e.g. "Floor 5" in "Floor 5, 80 Queen Street"string (max 20)Floor 5
streetStreet name. The name of the street / road, including prefixstring (max 60)Queen Street
suburbSuburb namestring (max 60)Auckland Central
cityName of the town or city provided by Land Information New Zealand (LINZ)string (max 60)Auckland
mailtownName of the town or city provided by NZ Poststring (max 60)Auckland
territoryTerritorial authority of the address. See districts of NZstring (max 20)Auckland
regionRegional authority of the address. See regions of NZstring (max 20)Auckland
postcodeNZ Post code used for defining an areastring (max 4)1010
buildingName of the buildingstring (max 60)Deloitte Centre
fullFull display name or label for an addressstring (max 90)80 Queen Street, Auckland Central, Auckland 1010
displaylineOne line address display namestring (max 70)80 Queen Street
address1Line 1 in a 4 address field formstring (max 60)Suite 8, Floor 3
address2Line 2 in a 4 address field formstring (max 60)80 Queen Street
address3Line 3 in a 4 address field formstring (max 60)Auckland Central
address4Line 4 in a 4 address field formstring (max 60)Auckland 1010
typeAddress Type (Urban, Rural, PostBox, NonPostal)string (max 9)URBAN
boxbagnumberThe PO Box number for PO Box addressesinteger100
boxbaglobbyNZ Post outlet or agency where the PO Box is locatedstring (max 60)Auckland
xLongitude coordinates in WGS84 formatstring (max 20)174.766357421875
yLatitude coordinates in WGS84 formatstring (max 20)-36.84621047973633
modifiedLast updated datedate2018-01-22
pafTrue/False to indicate if the address was sourced from PAF (or LINZ = false)booleantrue
deletedTrue/False to indicate if the address was deleted from the source (PAF or LINZ)booleanfalse

Response Example for id 2417575

https://api-nz.addysolutions.com/address/2417575?key=demo-api-key
{
    "id": 2417575,
    "dpid": 1540203,
    "linzid": 2027703,
    "parcelid": 6917300,
    "meshblock": 438102,
    "number": "80",
    "numberfull": "80",
    "numberdisplay": "80",
    "rdnumber": "",
    "alpha": "",
    "unittype": "",
    "unitnumber": "",
    "floor": "",
    "street": "Queen Street",
    "suburb": "Auckland Central",
    "city": "Auckland",
    "mailtown": "Auckland",
    "territory": "Auckland",
    "region": "Auckland",
    "postcode": "1010",
    "building": "",
    "full": "80 Queen Street, Auckland Central, Auckland 1010",
    "displayline": "80 Queen Street",
    "address1": "80 Queen Street",
    "address2": "Auckland Central",
    "address3": "Auckland 1010",
    "address4": "",
    "type": "Urban",
    "boxbagnumber": "",
    "boxbaglobby": "",
    "x": "174.766357421875",
    "y": "-36.84621047973633",
    "modified": "2018-01-22",
    "paf": true,
    "deleted": false
}

Response Example for id 2417575 with JSONP callback method "done345"

https://api-nz.addysolutions.com/address/2417575?key=demo-api-key&callback=done345

done345({
    "id": 2417575,
    "dpid": 1540203,
    "linzid": 2027703,
    "parcelid": 6917300,
    "meshblock": 438102,
    "number": "80",
    "numberfull": "80",
    "numberdisplay": "80",
    "rdnumber": "",
    "alpha": "",
    "unittype": "",
    "unitnumber": "",
    "floor": "",
    "street": "Queen Street",
    "suburb": "Auckland Central",
    "city": "Auckland",
    "mailtown": "Auckland",
    "territory": "Auckland",
    "region": "Auckland",
    "postcode": "1010",
    "building": "",
    "full": "80 Queen Street, Auckland Central, Auckland 1010",
    "displayline": "80 Queen Street",
    "address1": "80 Queen Street",
    "address2": "Auckland Central",
    "address3": "Auckland 1010",
    "address4": "",
    "type": "Urban",
    "boxbagnumber": "",
    "boxbaglobby": "",
    "x": "174.766357421875",
    "y": "-36.84621047973633",
    "modified": "2018-01-22",
    "paf": true,
    "deleted": false
  })

Try the free real-time address validation demo.

Sign up

Full support

Sign up

Full support

Address Services

Address AutocompleteAddress CleansingAddress GeocodingPostcode FinderPricingSign inSign up
© 2021 Addy LimitedTerms & Conditions
Made in Auckland, New Zealand
Looking for Addy Australia?