Query route details
After receiving a route ID through the route mutation, the route details can be queried. These route details will contain everything from a polyline to charge stations, ideal for plotting a route on a map or providing turn-by-turn instructions.
Render route and route data
Plot a route on a map and render the route detail data.
Query
To query the route details a route ID needs to be sent. Be sure to include the status in your response and check it. If your route hasn't completed processing yet, then your route details will not be available. To prevent this from happening you can use the subscription service.
If you also supported additional route options in the route mutation you will now be able to collect the details. Below you can find instructions on how to do that.
- Route sections
Every leg of the route includes the
sectionsproperty. These sections allow you to easily identify different road characteristics and highlight them in your application. The type of route sections aredriving,ferry, andwalking. Every step includes thedistance,duration,consumptionand a separatepolyline.
- Route tags
To retrieve the type of road characteristics included in the entire journey the
tagsproperty can be added when querying the route. Those includeroad,highway,toll,ferry,walkingandcrossborder. A list oftagsis included on both theRouteDetailsandRouteDetailsLeg.
- Support alternative stations along a route
If the route mutation included the
alternative_station_radiuswith a valid distance, the station details can be requested in this query. To do so, add thealternative_stationsfield with its appropriate children.
- Support stations as waypoint
If the route mutation included stations in the
viaparameter, the route will contain additional stations as waypoints. These stations as waypoints can be found inside therecommended.legswith the typestation_via.
- Get additional properties
The route legs origin an destination have an optional
propertiesattribute. This can be used to fetch details such as a completeaddress, the currenttemperatureandair_pressureat that location.
- Using unit arguments
All the fields that support unit conversion have a
unitargument that can be set. For example, therange_at_originandrange_at_destinationcan be retrieved inkilometer,mile,kilowatt_hourorpercentage. Please be aware that the percentages are based upon theusable_kwhor the capacity included inside this mutation.
- Path plot
Information about the route path is included under the
path_plotfield. It contains information aboutspeed,elevation,state_of_charge, and more.
- Meta information
The
RouteResponsecontains the newmetafield, which exposes additional information about the route, such asapp_idandcomputation_time. It will be extended in the future with even more information.
Arguments
id • ID
• Required
ID of a route.
Frequently used fields
status • RouteStatus
Status of a route.
Show RouteStatus enum values
pending
Route is queued and pending processing. Temporary status.
processing
We are computing the route for your request. Temporary status.
done
We finished computing the route, with a result. Final status.
not_found
We finished computing the route, without any result. Final status.
error
An error occurred while computing the route. Final status.
Other fields
id • ID
ID of a route calculation.
recommended • RouteDetails
Recommended route.
id • ID
ID of a route computation.
type • RouteDetailsType
Type of a computed route.
Show RouteDetailsType enum values
fastest
best_matching
alternative
connectors • RouteDetailsConnectors
Aggregation of the connectors.
all • RouteDetailsConnectorsValues
Aggregation of every connector on a route.
total • Int
Total numbers of connectors.
available • Int
Number of connectors with status available.
occupied • Int
Number of connectors with status occupied.
unknown • Int
Number of connectors with status unknown.
out_of_order • Int
Number of connectors with status out of order.
usable • RouteDetailsConnectorsValues
Aggregation of every usable connector on a route.
total • Int
Total numbers of connectors.
available • Int
Number of connectors with status available.
occupied • Int
Number of connectors with status occupied.
unknown • Int
Number of connectors with status unknown.
out_of_order • Int
Number of connectors with status out of order.
distance • Float
Total distance of a route.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
durations • RouteDetailsDurations
Aggregation of all durations of a route.
total • Int
Total duration, in seconds.
charging • Int
Total duration charging, in seconds.
driving • Int
Total duration driving, in seconds.
stopover • Int
Total duration stopped for a short stay, for example at a via point, in seconds.
ferry • Int
Total duration of ferry rides, in seconds.
consumption • Float
Total energy used for a route in kilowatt hours.
range_at_origin • Float
Range available at the beginning of a trip.
Show arguments
unit • StateOfChargeUnit
State of charge unit.
Default • kilowatt_hour
Show StateOfChargeUnit enum values
kilometer
Return the state of charge in kilometers.
mile
Return the state of charge in miles.
kilowatt_hour
Return the state of charge in kilowatt hours.
percentage
Return the state of charge as a percentage.
range_at_destination • Float
Range available at the end of a trip.
Show arguments
unit • StateOfChargeUnit
State of charge unit.
Default • kilowatt_hour
Show StateOfChargeUnit enum values
kilometer
Return the state of charge in kilometers.
mile
Return the state of charge in miles.
kilowatt_hour
Return the state of charge in kilowatt hours.
percentage
Return the state of charge as a percentage.
via • String
Text information about a route direction.
polyline • String
Polyline containing encoded coordinates.
Show arguments
decimals • PolylineInputDecimals
Show PolylineInputDecimals enum values
five
six
path_plot • RouteDetailsPathSegment
Path elevation, distance, duration, consumption and speed values, grouped into 100 segments.
elevation • Float
Elevation value of a route path segment.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
average_speed • Float
Average speed of a route path segment.
Show arguments
unit • SpeedUnit
Speed unit.
Default • kilometers_per_hour
Show SpeedUnit enum values
kilometers_per_hour
Return the speed in kilometers per hour.
miles_per_hour
Return the speed in miles per hour.
consumption • Float
Consumption, in kilowatt hours, of a route path segment.
distance • Float
Distance of a route path segment.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
duration • Float
Duration, in seconds, of a route path segment.
state_of_charge • Float
State of charge, in kilowatt hours, of a route path segment.
Show arguments
unit • StateOfChargeUnit
State of charge unit.
Default • kilowatt_hour
Show StateOfChargeUnit enum values
kilometer
Return the state of charge in kilometers.
mile
Return the state of charge in miles.
kilowatt_hour
Return the state of charge in kilowatt hours.
percentage
Return the state of charge as a percentage.
max_speed • Float
Maximum vehicle speed of a route path segment.
Show arguments
unit • SpeedUnit
Speed unit.
Default • kilometers_per_hour
Show SpeedUnit enum values
kilometers_per_hour
Return the speed in kilometers per hour.
miles_per_hour
Return the speed in miles per hour.
elevation • RouteDetailsElevation
Details about elevation on a route.
up • Float
Total value driving uphill on a route.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
down • Float
Total value driving downhill on a route.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
maximum • Float
Maximum elevation on a route.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
minimum • Float
Minimum elevation on a route.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
savings • RouteDetailsSavings
Money saving information.
money • Float
Money saved by a user driving this route with an electric vehicle.
average_gas_price • Float
Average gas price with which the calculation was made.
average_energy_price • Float
Average energy price with which the calculation was made.
legs • RouteDetailsLeg
Legs of a route.
distance • Float
Distance from the start to the end of a leg.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
durations • RouteDetailsDurations
Aggregation of all durations of a route leg.
total • Int
Total duration, in seconds.
charging • Int
Total duration charging, in seconds.
driving • Int
Total duration driving, in seconds.
stopover • Int
Total duration stopped for a short stay, for example at a via point, in seconds.
ferry • Int
Total duration of ferry rides, in seconds.
consumption • Float
Total energy used in a leg in kilowatt hours.
origin • RouteDetailsLegFeaturePoint
Origin point location.
type • FeatureType
Feature type.
Show FeatureType enum values
Feature
geometry • Point
Geometry of the feature.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
properties • RouteDetailsLegFeatureProperties
Properties of the feature.
name • String
Name of the location.
station_id • ID
ID of the station.
external_station_id • ID
External ID of the station.
temperature • Float
Temperature at the location.
Show arguments
unit • TemperatureUnit
Temperature unit.
Default • Celsius
Show TemperatureUnit enum values
Celsius
Return the temperature in Celsius.
Fahrenheit
Return the temperature in Fahrenheit.
air_pressure • Float
Air pressure at the location.
solar_irradiance • Float
Solar irradiance at the location.
duration • Int
Duration, in seconds, of time spent at this location.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • Float
Value of the current weight of the occupants.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
total_cargo_weight • Float
Value of the current weight of the cargo.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
destination • RouteDetailsLegFeaturePoint
Destination point location.
type • FeatureType
Feature type.
Show FeatureType enum values
Feature
geometry • Point
Geometry of the feature.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
properties • RouteDetailsLegFeatureProperties
Properties of the feature.
name • String
Name of the location.
station_id • ID
ID of the station.
external_station_id • ID
External ID of the station.
temperature • Float
Temperature at the location.
Show arguments
unit • TemperatureUnit
Temperature unit.
Default • Celsius
Show TemperatureUnit enum values
Celsius
Return the temperature in Celsius.
Fahrenheit
Return the temperature in Fahrenheit.
air_pressure • Float
Air pressure at the location.
solar_irradiance • Float
Solar irradiance at the location.
duration • Int
Duration, in seconds, of time spent at this location.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • Float
Value of the current weight of the occupants.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
total_cargo_weight • Float
Value of the current weight of the cargo.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
range_at_origin • Float
Range at the origin of the leg.
Show arguments
unit • StateOfChargeUnit
State of charge unit.
Default • kilowatt_hour
Show StateOfChargeUnit enum values
kilometer
Return the state of charge in kilometers.
mile
Return the state of charge in miles.
kilowatt_hour
Return the state of charge in kilowatt hours.
percentage
Return the state of charge as a percentage.
range_at_destination • Float
Range at the destination of the leg.
Show arguments
unit • StateOfChargeUnit
State of charge unit.
Default • kilowatt_hour
Show StateOfChargeUnit enum values
kilometer
Return the state of charge in kilometers.
mile
Return the state of charge in miles.
kilowatt_hour
Return the state of charge in kilowatt hours.
percentage
Return the state of charge as a percentage.
range_after_charge • Float
Range after charging on the leg.
Show arguments
unit • StateOfChargeUnit
State of charge unit.
Default • kilowatt_hour
Show StateOfChargeUnit enum values
kilometer
Return the state of charge in kilometers.
mile
Return the state of charge in miles.
kilowatt_hour
Return the state of charge in kilowatt hours.
percentage
Return the state of charge as a percentage.
type • RouteDetailsLegType
Type of a leg.
Show RouteDetailsLegType enum values
station
station_via
station_final
station_amenity
via
final
name • String
Name of a destination. This is the station name in case a user should charge or the name of the location in case this was provided.
station • RouteDetailsLegStation
Information about the station at the origin of this leg.
station_id • ID
ID of a station.
station_name • String
Name of a station.
operator_id • ID
ID of an operator.
operator_name • String
Name of an operator.
evse_uid • ID
ID of the EVSE that was selected in a route.
connector_id • ID
ID of the connector that was selected in a route.
amenities • AmenityType
List of amenities present at the station.
Show AmenityType enum values
park
restaurant
museum
coffee
hotel
shopping
bathroom
supermarket
playground
pharmacy
connectors • RouteDetailsConnectors
Aggregation of the connectors on the leg.
all • RouteDetailsConnectorsValues
Aggregation of every connector on a route.
total • Int
Total numbers of connectors.
available • Int
Number of connectors with status available.
occupied • Int
Number of connectors with status occupied.
unknown • Int
Number of connectors with status unknown.
out_of_order • Int
Number of connectors with status out of order.
usable • RouteDetailsConnectorsValues
Aggregation of every usable connector on a route.
total • Int
Total numbers of connectors.
available • Int
Number of connectors with status available.
occupied • Int
Number of connectors with status occupied.
unknown • Int
Number of connectors with status unknown.
out_of_order • Int
Number of connectors with status out of order.
polyline • String
Polyline containing encoded coordinates.
Show arguments
decimals • PolylineInputDecimals
Show PolylineInputDecimals enum values
five
six
tags • RouteDetailsTag
Aggregation of tags over the current leg. Tags are further subdivided over individual sections and maneuvers.
Show RouteDetailsTag enum values
road
highway
toll
ferry
walking
crossborder
maneuvers • RouteDetailsManeuver
Maneuvers of a leg - used to generate turn-by-turn instructions.
type • RouteDetailsLegManeuverType
Type of instruction.
Show RouteDetailsLegManeuverType enum values
UNKNOWN
U_TURN_UNKNOWN
U_TURN_LEFT
KEEP_LEFT
LEAVE_ROUNDABOUT
TURN_SHARP_LEFT
TURN_LEFT
TURN_SLIGHT_LEFT
CONTINUE_ON_STREET
TURN_SLIGHT_RIGHT
TURN_RIGHT
TURN_SHARP_RIGHT
FINISH
REACHED_VIA
REACHED_CHARGING_STATION
USE_ROUNDABOUT
KEEP_RIGHT
U_TURN_RIGHT
PT_START_TRIP
PT_TRANSFER
PT_END_TRIP
IGNORE
location • RouteDetailsLegFeaturePoint
Location of the maneuver.
type • FeatureType
Feature type.
Show FeatureType enum values
Feature
geometry • Point
Geometry of the feature.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
properties • RouteDetailsLegFeatureProperties
Properties of the feature.
name • String
Name of the location.
station_id • ID
ID of the station.
external_station_id • ID
External ID of the station.
temperature • Float
Temperature at the location.
Show arguments
unit • TemperatureUnit
Temperature unit.
Default • Celsius
Show TemperatureUnit enum values
Celsius
Return the temperature in Celsius.
Fahrenheit
Return the temperature in Fahrenheit.
air_pressure • Float
Air pressure at the location.
solar_irradiance • Float
Solar irradiance at the location.
duration • Int
Duration, in seconds, of time spent at this location.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • Float
Value of the current weight of the occupants.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
total_cargo_weight • Float
Value of the current weight of the cargo.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
name • String
Name of the street on which an instruction is.
distance • Float
Distance, in meters, of a route instruction.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
duration • Int
Duration, in seconds, of a route instruction.
points • RouteDetailsLegManeuverPoints
Information about the points on a polyline.
size • Int
Number of polyline points which are included in this instruction.
interval • Int
Interval of points that are included in this instruction, an array with 2 values, where the first value is the index of the polyline where the interval starts. The second value is where it ends.
exit_number • Int
Exit number on a roundabout. This field exists only on sign USE_ROUNDABOUT (6), otherwise this value is null.
turn_angle • Float
Curvature angle between the roundabout and the exit of the roundabout. This field exists only on sign USE_ROUNDABOUT (6), otherwise this value is null.
tags • RouteDetailsTag
Aggregation of tags over the current maneuver.
Show RouteDetailsTag enum values
road
highway
toll
ferry
walking
crossborder
sections • RouteDetailsLegSection
Road sections of a leg - divided by means of transportation.
type • RouteDetailsLegSectionType
Section type.
Show RouteDetailsLegSectionType enum values
driving
ferry
walking
origin • RouteDetailsLegSectionFeaturePoint
Origin point.
type • FeatureType
Feature type.
Show FeatureType enum values
Feature
geometry • Point
Geometry of the feature.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
properties • RouteDetailsLegSectionFeaturePointProperties
Properties of the feature.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • Float
Value of the current weight of the occupants.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
total_cargo_weight • Float
Value of the current weight of the cargo.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
destination • RouteDetailsLegSectionFeaturePoint
Destination point.
type • FeatureType
Feature type.
Show FeatureType enum values
Feature
geometry • Point
Geometry of the feature.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
properties • RouteDetailsLegSectionFeaturePointProperties
Properties of the feature.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • Float
Value of the current weight of the occupants.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
total_cargo_weight • Float
Value of the current weight of the cargo.
Show arguments
unit • WeightUnit
Weight unit.
Default • kilogram
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
tags • RouteDetailsTag
Aggregation of tags over the current section.
Show RouteDetailsTag enum values
road
highway
toll
ferry
walking
crossborder
polyline • String
Polyline containing encoded coordinates.
Show arguments
decimals • PolylineInputDecimals
Show PolylineInputDecimals enum values
five
six
distance • Float
Distance from the start to the end of a section.
Show arguments
unit • DistanceUnit
Distance unit.
Default • meter
Show DistanceUnit enum values
meter
Return the distance in meters.
foot
Return the distance in feet.
kilometer
Return the distance in kilometers.
mile
Return the distance in miles.
duration • Float
Total drive time from the start to the end of a section, in seconds.
consumption • Float
Total energy used in a section in kilowatt-hours.
alternative_stations • RouteDetailsAlternativeStation
id • ID
ID of a station.
location • Point
GeoJSON location of a station.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
speed • StationSpeedType
Speed of a station. A station along a route can be either fast or turbo.
Show StationSpeedType enum values
slow
Slow charging (below 43 kW).
fast
Fast charging stations (above 43 kW and below 150 kW).
turbo
Ultra fast charging stations (above 150 kW).
status • ChargerStatus
Status of a station.
Show ChargerStatus enum values
free
The charger is free.
busy
The charger is occupied/busy.
unknown
The charger is unknown.
error
The charger has an error.
operator_ranking • Int
Ranking of an operator.
tags • RouteDetailsTag
Aggregation of tags over the current RouteDetails. Tags are available on legs and further subdivided over individual sections and maneuvers.
Show RouteDetailsTag enum values
road
highway
toll
ferry
walking
crossborder
charges • Int
Number of charges along a route.
meta • RouteMetadata
Meta data for a route.
app_id • ID
Refers to the x-app-id specified in the headers.
created_at • DateTime
Date when a route was created by a createRoute mutation.
updated_at • DateTime
Last updated date of a route.
computation_time • Int
Length of time required to successfully calculate a route, in milliseconds.
request_input • CreateRoute
Route request.
vehicle • RouteVehicle
Vehicle used on a route.
id • ID
ID of the vehicle.
battery • RouteVehicleBattery
EV battery specific configuration.
capacity • StateOfCharge
Battery capacity.
value • Float
Value of the state of charge of the vehicle.
type • StateOfChargeUnit
Type of the state of charge of the vehicle.
Show StateOfChargeUnit enum values
kilometer
Return the state of charge in kilometers.
mile
Return the state of charge in miles.
kilowatt_hour
Return the state of charge in kilowatt hours.
percentage
Return the state of charge as a percentage.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
state_of_charge • StateOfCharge
State of charge.
value • Float
Value of the state of charge of the vehicle.
type • StateOfChargeUnit
Type of the state of charge of the vehicle.
Show StateOfChargeUnit enum values
kilometer
Return the state of charge in kilometers.
mile
Return the state of charge in miles.
kilowatt_hour
Return the state of charge in kilowatt hours.
percentage
Return the state of charge as a percentage.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
final_state_of_charge • StateOfCharge
Minimum final battery state of charge.
value • Float
Value of the state of charge of the vehicle.
type • StateOfChargeUnit
Type of the state of charge of the vehicle.
Show StateOfChargeUnit enum values
kilometer
Return the state of charge in kilometers.
mile
Return the state of charge in miles.
kilowatt_hour
Return the state of charge in kilowatt hours.
percentage
Return the state of charge as a percentage.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
temperature • Temperature
Temperature of the battery.
value • Float
Value of the temperature.
type • TemperatureUnit
Type of temperature.
Show TemperatureUnit enum values
Celsius
Return the temperature in Celsius.
Fahrenheit
Return the temperature in Fahrenheit.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
current • Float
Battery current in ampere.
voltage • Float
Battery voltage in volts.
power • Float
Value of the positive or negative power. When negative, the vehicle is charging.
is_charging • Boolean
Indicates if the vehicle is charging.
charging • RouteVehicleCharging
Charging configuration.
mode • ChargeMode
Mode that indicates if the charging time is optimized or if always charged to the maximum capacity.
Show ChargeMode enum values
OPTIMIZE_TRAVEL_TIME
Optimizes the charging time at each station, in order to decrease the total travel time. You will only charge up until the SOC you need in order to reach the next stop.
ALWAYS_TO_MAX_CHARGE
Charge to the maximum capacity at every charging stop. The default maximum charging capacity is 80%.
minimum_power • Int
Minimum desired power of chargers.
risk_margin • Int
Percentage for the minimum limit of the battery's capacity before a recharge. The value should be between 0 and 60. Defaults to 10.
connectors • RouteVehicleChargingConnector
Supported connectors.
standard • ConnectorType
Type of the plug.
Show ConnectorType enum values
CHADEMO
The connector type is CHAdeMO, DC.
DOMESTIC_A
Standard/domestic household, type "A", NEMA 1-15, 2 pins.
DOMESTIC_B
Standard/domestic household, type "B", NEMA 5-15, 3 pins.
DOMESTIC_C
Standard/domestic household, type "C", CEE 7/17, 2 pins.
DOMESTIC_D
Standard/domestic household, type "D", 3 pins.
DOMESTIC_E
Standard/domestic household, type "E", CEE 7/5 3 pins.
DOMESTIC_F
Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.
DOMESTIC_G
Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.
DOMESTIC_H
Standard/domestic household, type "H", SI-32, 3 pins.
DOMESTIC_I
Standard/domestic household, type "I", AS 3112, 3 pins.
DOMESTIC_J
Standard/domestic household, type "J", SEV 1011, 3 pins.
DOMESTIC_K
Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.
DOMESTIC_L
Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.
DOMESTIC_M
Standard/Domestic household, type "M", BS 546, 3 pins.
DOMESTIC_N
Standard/Domestic household, type "N", NBR 14136, 3 pins.
DOMESTIC_O
Standard/Domestic household, type "O", TIS 166-2549, 3 pins.
IEC_60309_2_single_16
IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).
IEC_60309_2_three_16
IEC 60309-2 Industrial connector three phase 16 amperes (usually red).
IEC_60309_2_three_32
IEC 60309-2 Industrial connector three phase 32 amperes (usually red).
IEC_60309_2_three_64
IEC 60309-2 Industrial connector three phase 64 amperes (usually red).
IEC_62196_T1
IEC 62196 Type 1 "SAE J1772".
IEC_62196_T1_COMBO
Combo Type 1 based, DC.
IEC_62196_T2
IEC 62196 Type 2 "Mennekes".
IEC_62196_T2_COMBO
Combo Type 2 based, DC.
IEC_62196_T3A
IEC 62196 Type 3A.
IEC_62196_T3C
IEC 62196 Type 3C "Scame".
PANTOGRAPH_BOTTOM_UP
On-board bottom-up-pantograph typically for bus charging.
PANTOGRAPH_TOP_DOWN
Off-board top-down-pantograph typically for bus charging.
TESLA_R
Tesla connector "Roadster"-type (round, 4 pins).
TESLA_S
Tesla connector "Model-S"-type (oval, 5 pins).
GB_T
The connector type is GB_T (Chinese standard), DC.
CHAOJI
The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
NEMA_5_20
The connector type is NEMA 5-20, 3 pins.
NEMA_6_30
The connector type is NEMA 6-30, 3 pins.
NEMA_6_50
The connector type is NEMA 6-50, 3 pins.
NEMA_10_30
The connector type is NEMA 10-30, 3 pins.
NEMA_10_50
The connector type is NEMA 10-50, 3 pins.
NEMA_14_30
The connector type is NEMA 14-30, 3 pins, rating of 30 A.
NEMA_14_50
The connector type is NEMA 14-50, 3 pins, rating of 50 A.
max_charge_speed • ChargeSpeed
Maximum charging speed for the plug.
value • Float
Value of the charge speed of the battery.
type • ChargeSpeedUnit
Type of the charge speed of the battery.
Show ChargeSpeedUnit enum values
kilowatt_hour
Return the charge speed in kilowatt hours.
kilometers_per_hour
Return the charge speed in kilometers per hour.
miles_per_hour
Return the charge speed in miles per hour.
source • TelemetryInputSource
Source of inputted data
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
adapters • RouteVehicleChargingConnector
Supported adapters.
standard • ConnectorType
Type of the plug.
Show ConnectorType enum values
CHADEMO
The connector type is CHAdeMO, DC.
DOMESTIC_A
Standard/domestic household, type "A", NEMA 1-15, 2 pins.
DOMESTIC_B
Standard/domestic household, type "B", NEMA 5-15, 3 pins.
DOMESTIC_C
Standard/domestic household, type "C", CEE 7/17, 2 pins.
DOMESTIC_D
Standard/domestic household, type "D", 3 pins.
DOMESTIC_E
Standard/domestic household, type "E", CEE 7/5 3 pins.
DOMESTIC_F
Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.
DOMESTIC_G
Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.
DOMESTIC_H
Standard/domestic household, type "H", SI-32, 3 pins.
DOMESTIC_I
Standard/domestic household, type "I", AS 3112, 3 pins.
DOMESTIC_J
Standard/domestic household, type "J", SEV 1011, 3 pins.
DOMESTIC_K
Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.
DOMESTIC_L
Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.