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

Bounding Box Address API

Retrieve the addresses within a bounding box of GPS coordinates

Overview


Given a bounding box / polygon of latitude (Y) and longitude (X) GPS coordinates, the Bounding Box API will return a collection of all the addresses within that area.

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

There are online tools to draw a polygon that can be used for querying the API.

API Endpoint


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

cURL Request


The example below will make a JSON request to find the addresses within a bounding box area (174.750338 -36.846513,174.751035 -36.845448,174.752451 -36.845912,174.751647 -36.847097):

1curl -X GET --header 'Accept: application/json' 'https://api-nz.addysolutions.com/boundingbox?key=demo-api-key&coordinates=174.750338 -36.846513,174.751035 -36.845448,174.752451 -36.845912,174.751647 -36.847097'
Remember to replace demo-api-key with your own API key.

Request Parameters


ParameterDescriptionTypeExample
limitNumber of addresses to return per batch (default = 100, maximum = 1000)integer200
offsetOffset to continue the paging (default = 0)integer5
coordinatesA collection of coordinates in WGS84 formatstring174.750338 -36.846513,174.751035
-36.845448,174.752451
-36.845912,174.751647 -36.847097

Response Properties


PropertyDescriptionTypeExample
addressesArray of address resultsaddress array[{address},{address}]
_linksLink for paging to the next set of resultsURI/boundingbox?x=174.754325&y=-36.846829&offset=10&limit=10

Address Response Property Description

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 addresses in a bounding box area (174.750338 -36.846513,174.751035 -36.845448,174.752451 -36.845912,174.751647 -36.847097):
https://api-nz.addysolutions.com/boundingbox/key=demo-api-key&limit=3&coordinates=174.750338 -36.846513,174.751035 -36.845448,174.752451 -36.845912,174.751647 -36.847097

{
    "addresses": [
      {
        "id": 2760578,
        "displayname": "3/20 Beaumont Street, Auckland Central, Auckland 1010",
        "_link": "/address/2760578"
      },
      {
        "id": 2760577,
        "displayname": "2/20 Beaumont Street, Auckland Central, Auckland 1010",
        "_link": "/address/2760577"
      },
      {
        "id": 2760576,
        "displayname": "1/20 Beaumont Street, Auckland Central, Auckland 1010",
        "_link": "/address/2760576"
      }
    ],
    "_links": {
      "next": "/boundingbox?coordinates=174.750338+-36.846513%2C174.751035+-36.845448%2C174.752451+-36.845912%2C174.751647+-36.847097&limit=3&offset=3"
    }
  }

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?