This endpoint can be used to retrieve the closest locations from a point ordered by distance or the locations around a point (inside a geographical circle with a given radius (in meters)). You can also choose the number of results. By default, the endpoint only returns the closest location.
The coordinates
of the point (or center of the circle) must be passed as path parameter as coordinates pair longitude,latitude
.
The query parameter locationTypes
allows to filter the types returned. A list of values can be passed among port,airport,zipcode,railTerminal, roadTerminal
.
If this parameter is not passed in the query, all the types will be searched.
The query parameter sizes
allows to filter the sizes of the locations returned for ports and airports.
For each location found, geometry (coordinates) is returned as well as a properties
field that contains different information according to the type of the location.
For ports : name
, locode
, country
, countryName
, size
and distance
(in meters) from the point passed in the query.
For airports : name
, locode
, size
, iataCode
, countryName
, countryCode
(as a two letters code), subdivisionName
, city
.
For zipcodes : name
, countryCode
, countryName
, postalCode
and distance
(in meters) from the point passed in the query.
For rail terminals and road terminals : name
, locode
, countryCode
, countryName
and distance
(in meters) from the point passed in the query.