Address APIs
Bounding Box Address API
Retrieve the addresses within a bounding box of GPS coordinates
Run any Addy API live with Addy Swagger UI on us for free with 'demo-api-key' API key
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.
There are online tools to draw a polygon that can be used for querying the API.
API Endpoint
| URL | https://api-nz.addysolutions.com/boundingbox |
| HTTP Request Type | GET |
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'Request Parameters
| Parameter | Description | Type | Example |
|---|---|---|---|
| coordinates | A collection of coordinates in WGS84 format | string | 174.750338 -36.846513,174.751035 -36.845448,174.752451 -36.845912,174.751647 -36.847097 |
| 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 |
|---|---|---|---|
| addresses | Array of address results | address array | [{address},{address}] |
| _links | Link for paging to the next set of results | URI | /boundingbox?x=174.754325&y=-36.846829&offset=10&limit=10 |
Address Response Property Description
| 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 |
| _link | Link to Details API for retrieving metadata | string | /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": 1226294,
"displayname": "20 Beaumont Street, Auckland Central, Auckland 1010",
"_link": "/address/1226294"
},
{
"id": 1226290,
"displayname": "77 Fisher-Point Drive, Auckland Central, Auckland 1010",
"_link": "/address/1226290"
},
{
"id": 1226289,
"displayname": "88 Fisher-Point Drive, Auckland Central, Auckland 1010",
"_link": "/address/1226289"
}
],
"_links": {
"next": "?coordinates=174.750338%20-36.846513%2C174.751035%20-36.845448%2C174.752451%20-36.845912%2C174.751647%20-36.847097&limit=3&offset=3"
}
}
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