Create a new route
As described in the route introduction, the first thing you will need to do is fetch a
route ID. This
route ID can then be sent to subscribe to route details and retrieve a polyline and other route data.
Render route and route data
Plot a route on a map and render the route detail data.
To get a
route ID, you will need to provide us with EV details and at least a departure location and destination. Apart from that you can also support any of the options that are described below.
If you want to request alternative charging stations along a route, you can set the
stationsAlongRouteRadiusproperty of the route mutation. The radius can be set between
5000meters. This will return all applicable stations within the set radius following the specified powers and standards.
You can add a station as a waypoint or as a destination. To do this, add
If you want to apply cargo and occupants, you can set
ev.occupants. You can overwrite these values on a leg basis by setting the
routeRequest.origin.propertiesand any of the
routeRequest.via.properties. If you do not set the values to
0, each leg inherits the values from the previous one or from the
Our route destination, origin and stations have an optional
propertiesattribute in any of our route queries. You can use this to fetch a complete
address, the current temperature (
temp) and air
pressureat that location.
You can configure this query to use percentages for the state of charge and final state of charge. This way client-side conversions are no longer needed. Please be aware that the percentages are based upon the
usableCarBatteryor the capacity included inside this mutation.
In your route request, you can rank or exclude operators based on preference. We support ten different levels of preference. Level 1 is considered the highest level, and level 10 is the lowest. It is possible to skip levels or add multiple operators to the same level. Every level lowers the preference by 10 percent. Enable your operator ranking by setting it to
required. If you always prefer and exclude the same operators, we recommend that you add your operator ranking to your client configuration instead. The route request will override any client configuration you might have.
In the route request you can define a list of amenities that should be available at the charge stations. Valid amenity types are:
pharmacy. The route that matches the requested amenities best will be available as a route alternative with the type
bestMatching. If you did include an operator ranking object in your route request this ranking is equally taken into account. Use the amenity list query to retrieve the amenity details for a station id.
If successful, the HTTP status code in the response header is 200 and the response body contains the attributes you requested.
If unsuccessful, the header status code is an error code and the response body contains an error response object. The error response object can be any of the ones below.
Errors and warnings
No car was found with the provided ID
You are forbidden to execute this operation
Negative value for $LOCATION is not allowed.
Operator $OPERATORID is in both in the ranking and excluded lists
Operator $OPERATORID is present multiple times in the exclude lists
Operator $OPERATORID is present multiple times in the ranking lists
Operator ranking must be between 1 and 10!
No operator was found with the $OPERATORID ID
The route operator type was set to $ROUTEOPTYPE, but no ranking was provided. Please add an operator to your client or route request
The provided battery capacity is too high. The value must be less than or equal to $MAX kwh
The provided battery capacity is too small. The value must be greater than or equal to $MIN kwh
Provided amount of cargo weight is not valid . The value must be greater than 0.
Provided consumption value for $NAME is not valid. The value must be between 0 and $MAXVALUE for this car
Provided consumption value for $NAME is not valid. The worst value must be greater than or equal to best value
Provided consumption values are not valid. The total must be between 0 and $MAXVALUE for this car
The destination station for the route requested was not matched with the external station
The destination station for the route requested was not found with the provided ID
Amenities $DUPLICATEDAMENITIES are duplicated
The provided final state of charge is too high. The value must be less than or equal to 80% of the car battery capacity
Amenities $INVALIDAMENITIES are not valid. Allowed: $ALLOWEDAMENITIES
The destination coordinates provided are not valid
The origin coordinates provided are not valid
The via coordinates provided are not valid
Provided number of passengers is not valid. The value must be between 1 and $PASSENGERCOUNT for this car
The provided minimum power is too small. The value must be greater than 0 kwh
Provided number of occupants is not valid. The value must be less than $OCCUPANTSCOUNT for this car.
Provided number of occupants is not valid. The value must be at least 1.
The origin station for the route requested was not matched with the external station
The origin station for the route requested was not found with the provided ID
The radius value is above allowed, the maximum value is 5000 meters
The radius value is below allowed, the minimum value is 500 meters
The provided state of charge is too high. The value must be less than or equal to the car battery capacity
The charger standard used on this car is not supported by the station
The minimum power requested is higher than the station could support
The station speed is not fast or turbo
Provided amount of cargo is not valid. The value must be greater than 0.
Provided number of occupants for via is not valid. The value must be less than $VIAOCCUPANTSCOUNT for this car.
Provided number of occupants for via is not valid. The value must be at least 1.
The via station for the route requested was not matched with the external station
The via station for the route requested was not found with the provided ID
Coordinates [$DESTINATIONCOORDINATES] of destination don't match with station coordinates [$STATIONCOORDINATES]
Coordinates [$ORIGINCOORDINATES] of origin don't match with station coordinates [$STATIONCOORDINATES]
Coordinates [$VIACOORDINATES] of via don't match with station coordinates [$STATIONCOORDINATES]
Zero or negative value for $LOCATION is not allowed.