Geocoding: UK RetrieveNearestPlaces

Find nearest UK places of interest within a radius from postcodes or coordinates. Returns locations with distances in metres and OS grid references.

GET /Geocoding/UK/RetrieveNearestPlaces/v1.20/json6.ws

Geocoding_UK_RetrieveNearestPlaces

cURL

curl --request GET \
  --url 'https://api.addressy.com/Geocoding/UK/RetrieveNearestPlaces/v1.20/json6.ws?Key='

200

Success

{
  "Items": [
    {
      "Postcode": "WR2 6NJ",
      "Distance": "92.7",
      "Easting": "381687",
      "Northing": "259432",
      "Latitude": "52.2327",
      "Longitude": "-2.2696",
      "OsGrid": "SO 81687 59432"
    }
  ]
}

This method will consume credit.

Authorizations

Key · string · query · required

Query Parameters

Key · string · required

The key to use to authenticate to the service.

CentrePoint · string · required

A postcode or coordinates (latitude, longitude or easting, nothing) of the centre of the search. Can also be a place name.

MaximumItems · integer

The maximum number of items to return. If 0, all items are returned.

MaximumRadius · number

The maximum search distance in KM between the origin and a point of interest. If blank or 0, all items are returned.

FilterOptions · string

The type of filter to apply where the search returns a list of towns.

Response

200

application/json

Success

Items · object[]

Show child attributes