Address APIs
Address Finder API
Address Validation API
Address Details API
Address Discovery API
Postcode Finder API
Geocode Address API
Bounding Box API
Geocode Address API
Turn GPS coordinates into the nearest addresses with reverse geocoding
Run any Addy API live with Addy Swagger UI on us for free with 'demo-api-key' API key
Overview
Given latitude (Y) and longitude (X) GPS coordinates and an optional distance filter, the Geocode Address API will return a collection of the closes addresses.
- Visit the Geocode and Reverse Geocode page to see a live demo of this API in action.
- Vist the Bulk Reverse Geocoding page to turn a CSV or Excel spreadsheet of latitude and longitude coordinates into addresses
500 FREE Geocode Address API call per month. Busy month? Choose a plan to meet your needs.
API Endpoint
| URL | https://api-nz.addysolutions.com/geocode |
| HTTP Request Type | GET |
cURL Request
The example below will make a JSON request to find the addresses closest to Victoria Park in Auckland (-36.846829, 174.754325):
1curl -X GET --header 'Accept: application/json' 'https://api-nz.addysolutions.com/geocode?x=174.754325&y=-36.846829&distancekm=0.160&key=demo-api-key' Remember to replace demo-api-key with your own API key.
Request Parameters
| Parameter | Description | Type | Example |
|---|---|---|---|
| x | Longitute in WGS84 format | double | 174.754325 |
| y | Latitude in WGS84 format | double | -36.846829 |
| distancekm | Maximum distance in kilometers from the point. Default = 0.2 (200 metres). Maximum = 50 (km). | double | 35.754325 |
| limit | Number of addresses to return per batch (default = 100, maximum = 1000) | integer | 200 |
| offset | Offset to continue the paging (default = 0) | integer | 5 |
Response Properties
| Property | Description | Type | Example |
|---|---|---|---|
| id | Unique identifier for the address | integer | 5334946 |
| displayname | Full display name of the address | string | 203-271 Victoria Street West, Auckland Central, Auckland 1010 |
| distancekm | Approximate distance between the address and the coordinates | double | 0.15607143886453542 |
| _link | Link to Details API for retrieving metadata | string | /address/5334946 |
Response Example for retrieving the closes addresses to Victoria Park in Auckland (-36.846829, 174.754325):
https://api-nz.addysolutions.com/geocode?x=174.754325&y=-36.846829&distancekm=0.5&limit=5&key=demo-api-key
{
"addresses": [
{
"id": 2834475,
"displayname": "203 Victoria Street West, Auckland Central, Auckland 1010",
"distancekm": 0.14764923527048557,
"_link": "/address/2834475"
},
{
"id": 5725601,
"displayname": "Unit 1, Floor G, 1/155 Fanshawe Street, Auckland Central, Auckland 1010",
"distancekm": 0.1647227565062444,
"_link": "/address/5725601"
},
{
"id": 5725602,
"displayname": "Unit 2, Floor G, 2/155 Fanshawe Street, Auckland Central, Auckland 1010",
"distancekm": 0.1647227565062444,
"_link": "/address/5725602"
},
{
"id": 5725603,
"displayname": "Level 4, 155 Fanshawe Street, Auckland Central, Auckland 1010",
"distancekm": 0.1647227565062444,
"_link": "/address/5725603"
},
{
"id": 5725604,
"displayname": "Level 3, 155 Fanshawe Street, Auckland Central, Auckland 1010",
"distancekm": 0.1647227565062444,
"_link": "/address/5725604"
}
],
"_links": {
"next": "?x=174.754325&y=-36.846829&distancekm=0.5&limit=5&key=demo-api-key&offset=5"
}
}
Remember to replace demo-api-key with your own API key.
Address Services
Address AutocompleteAddress CleansingAddress GeocodingPostcode FinderPricingSign inSign upAddress APIs
Address Finder APIAddress Validation APIAddress Details APIAddress Discovery APIPostcode Finder APIGeocode Address APIBounding Box API