GET
/
Geocoding
/
International
/
RetrieveNearestPlaces
/
v1.00
/
json6.ws
cURL
curl --request GET \
  --url https://api.addressy.com/Geocoding/International/RetrieveNearestPlaces/v1.00/json6.ws
{
  "Items": [
    {
      "Location": "WR2 6NJ",
      "Distance": "92.7",
      "Latitude": "52.2327",
      "Longitude": "-2.2696"
    }
  ]
}
This method will consume credit.

Query Parameters

​
Key
string
required

The key to use to authenticate to the service.

​
Country
string

The ISO3 character code for the country to search in. This parameter is optional, but if you wish to use a place for the centre point the country code must be provided.

​
CentrePoint
string
required

A postcode or coordinates (latitude, longitude) of the centre of the search. Can also be a place name (corresponding country code must be provided).

​
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

The response is of type object.