API Reference

Route search

post
https://{environment}.plugsurfing.com/drive/v1/geosearch/route

Search for charging locations along a route. The max number of points in a route is 300. Prices are not included. To get prices for a given location, use Get location by id

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
Defaults to 3000

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

number
≤ 300
Defaults to 300

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

boolean
Defaults to false

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

number
2 to 9

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.

string
length between 2 and 2

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

Body Params
points
array of objects

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

points
filters
object

Filtering criteria applied to candidate charging locations.

options
object

Additional options controlling route search behavior.

Responses

Updated about 2 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago