The key you want to use to authenticate with the service (you can request we create one for you or create one in your account section).
AddressIdstring
LocationListIdstring
A GuID that identifies a list previously created using our Create List API. When this field is populated with a valid ID, the API will utilise the list for your destination locations.
MaxDistancenumber double
The maximum straight line distance radius of results that will be returned, starting from the original location, in metres. For example, setting a maxDistance of 100000 will only return results within a 100km radius of the origin. By default this is set to 100km with a maximum value of 500km. A smaller search radius will improve performance.
InputUnit'Meters' | 'Miles' | 'Kilometers'
MaxResultsinteger
The maximum number of locations you want returned. By default this is set to 10 with a maximum value of 100. Reducing the number of results returned will also improve performance.