Address Reverse Geocode API

This API takes GPS coordinates (latitude and longitude) and returns the nearest matching addresses, ordered by distance. It works in tandem with the Address Metadata API to load detailed information for a selected address.

Endpoint

New Zealand

https://api.addressfinder.io/api/nz/address/reverse_geocode

Parameters

Parameter	Default	Description
`key`		Your unique Addressfinder license key. Required string
`secret`		Your unique secret key. You can also pass it in the `Authorization` header. Only required for server-to-server calls. Optional string
`format`	`json`	Response format. Required string
`x`		Longitude in WGS84 format. Required string
`y`		Latitude in WGS84 format. Required string
`domain`		Used to identify your service in the Addressfinder Portal. Must be registered in the Portal. Optional string
`max`	`10`	Maximum number of results to return (1–100). Optional integer

Responses

200 Closest addresses to the provided coordinates

Name	Type	Description	Example
`success`	boolean	True if the query completed successfully.	true
`completions`	array		-
`a`	string	Canonical address.	184 Willis Street, Te Aro, Wellington 6011
`pxid`	string	Unique address identifier.	2-.F.1W.p.0G1Jx

400 Invalid input or missing required parameters

Name	Type	Description	Example
`error`	string		Missing required parameter 'x'

See API Error Reference for details.