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

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.

500 FREE Geocode Address API call per month. Busy month? Choose a plan to meet your needs.

API Endpoint


URLhttps://api-nz.addysolutions.com/geocode
HTTP Request TypeGET

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


ParameterDescriptionTypeExample
xLongitute in WGS84 formatdouble174.754325
yLatitude in WGS84 formatdouble-36.846829
distancekmMaximum distance in kilometers from the point. Default = 0.2 (200 metres). Maximum = 50 (km).double35.754325
limitNumber of addresses to return per batch (default = 100, maximum = 1000)integer200
offsetOffset to continue the paging (default = 0)integer5

Response Properties


PropertyDescriptionTypeExample
idUnique identifier for the addressinteger5334946
displaynameFull display name of the addressstring203-271 Victoria Street West, Auckland Central, Auckland 1010
distancekmApproximate distance between the address and the coordinatesdouble0.15607143886453542
_linkLink to Details API for retrieving metadatastring/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.

Sign up

Full support

Sign up

Full support

Address Services

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