Skip to main content
POST

Authorizations

X-API-Key
string
header
required

API key for authentication

Query Parameters

width
number
default:3000

Distance to search from the center of the route, in meters (will be split equally on both sides of the route)

limit
number
default:300

Number of locations returned in the response (doesn't apply when aggregation is enabled)

Required range: x <= 300
aggregate
boolean
default:false

If true, the results will be aggregated. For large radius it makes the response much faster.

aggregationPrecision
number

Value between 2 and 9. The bigger value is, the smaller is the cell size of the grid for aggregation. If not passed, a default value, based on radius, is assumed.

Required range: 2 <= x <= 9
language
string

Supported languages: en, bg, cy, de, es, fi, fr, hu, is, it, lt, nb, nl, pl, pt, ro, sv.

Required string length: 2

Body

application/json

The request takes up to 300 points for the route

points
object[]

Ordered route points (latitude/longitude) used to search along the route. The latitude and longitude values are string fields in this request body.

filters
object

Filtering criteria applied to candidate charging locations.

Response

OK

Response payload containing matching locations and aggregate metadata for a geosearch query.

locations
object[]
required

Locations matching the geosearch criteria.

aggregates
object[]

Present only if 'aggregate' request param = true. Contains only aggregates of 2 or more locations. Single locations are returned in 'locations' array.