GeoLocation - UK Only

Find UK addresses within a radius of latitude/longitude coordinates using Ordnance Survey data. Returns address IDs for use with Retrieve API.

GET /Capture/Interactive/GeoLocation/v1.00/json6.ws

Capture_Interactive_GeoLocation

cURL

curl --request GET \
  --url 'https://api.addressy.com/Capture/Interactive/GeoLocation/v1.00/json6.ws?Key='

200

Success

{
  "Items": [
    {
      "Id": "RG|131147105004049155081056163145037055217164007108",
      "Type": "Address",
      "Text": "Loqate",
      "Description": "Worcester, WR5 3DA",
      "Latitude": "52.182728",
      "Longitude": "-2.2221217"
    }
  ]
}

The GeoLocation service takes latitude longitude coordinates and returns addresses that are within a specified radius. This must be followed by a Retrieve to obtain a fully formatted address.

This service is only available for UK addresses, using Ordnance Survey data

This method will consume credit.

We don’t support API connections using HTTP - all calls should use HTTPS.

Authorizations

Key · string · query · required

Query Parameters

Key · string · required

The key used to authenticate with the service. For example: 'AA11-AA11-AA11-AA11'

Latitude · string · required

The latitude of the location you want to return an address for. We recommend using coordinates with up to six decimal degrees for as much granularity as possible.

Longitude · string · required

The longitude of the location you want to return an address for. We recommend using coordinates with up to six decimal degrees for as much granularity as possible.

Items · integer

The maximum number of items to return. This can be set to a maximum of 50.

Radius · integer

The maximum radius of the geo-location search in metres. This can be set to a maximum of 200 metres.

Response

200

application/json

Success

Items · object[]

Show child attributes