Query a navigation session
When you have obtained a navigation id through the startNavigation mutation, you can query for its current state.
Query
To query the navigation details you will need to provide the navigation ID as an argument. For doing turn-by-turn navigation we strongly recommend you to use the subscription service together with the navigation query.
Arguments
id • ID
• Required
ID of the navigation session to retrieve
Other fields
id • ID
ID of the navigation session.
overview • NavigationOverview
Navigation session details overview.
state_of_charge • Float
State of charge at the last known location.
Show arguments
unit • StateOfChargeUnit
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.
last_known_location • Point
Last known location.
type • PointType
Point type.
Show PointType enum values
Point
coordinates • Float
The coordinates array with longitude as first value and latitude as second one.
next_station • NavigationStation
Next charging station.
station_id • ID
The ID as string of the charging station.
station_location • Point
GPS location of the charging 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.
via • Point
An array with all GPS locations of via points until the next charging 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.
estimated_state_of_charge • Float
Estimated state of charge, at arrival on the next charging station.
Show arguments
unit • StateOfChargeUnit
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.
estimated_consumption • Float
Estimated consumption, in kWh, from last the known location until the next charging station.
estimated_duration • Float
Estimated duration, in seconds, from the last known location until the next charging station.
alternative_stations • NavigationStation
A set of alternative charging stations to next station.
station_id • ID
The ID as string of the charging station.
station_location • Point
GPS location of the charging 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.
via • Point
An array with all GPS locations of via points until the next charging 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.
estimated_state_of_charge • Float
Estimated state of charge, at arrival on the next charging station.
Show arguments
unit • StateOfChargeUnit
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.
estimated_consumption • Float
Estimated consumption, in kWh, from last the known location until the next charging station.
estimated_duration • Float
Estimated duration, in seconds, from the last known location until the next charging station.
instructions • RouteInstruction
Navigation route instructions.
points • RouteInstructionPoints
Information about the points on the polyline.
size • Int
Number of polyline points which are included in this instruction.
interval • Int
The 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.
sign • RouteInstructionSign
Sign of the instruction. See RouteInstructionSign.
Show RouteInstructionSign 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
name • String
Name of the street on which the instruction is.
distance • Int
Distance, in meters, of the current route instruction.
time • Int
Duration, in seconds, of the current route instruction.
exit_number • Int
Exit number on a roundabout. This field exists only on sign USE_ROUNDABOUT (6), otherwise is null.
turn_angle • Float
Curvature angle between the roundabout and street you exit the roundabout. This field exists only on sign USE_ROUNDABOUT (6), otherwise is null.
live_route_request • CreateRoute
Continuously updated route request input.
vehicle • RouteVehicle
Vehicle used on a route.
id • ID
ID of the vehicle.
battery • RouteVehicleBattery
EV battery specific configuration.
capacity • StateOfCharge
Usable capacity of a battery used to compute a route. Value must be between 50% and 150%. If not provided, it defaults to the vehicle battery.usable_kwh.
value • Float
Value of the state of charge of the vehicle.
type • StateOfChargeUnit
Preferred unit for the vehicle's state of charge.
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.
default
Default value.
state_of_charge • StateOfCharge
Current amount of energy in a battery. If not provided, it is assumed the battery is fully charged and equal to the vehicle battery.capacity.
value • Float
Value of the state of charge of the vehicle.
type • StateOfChargeUnit
Preferred unit for the vehicle's state of charge.
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.
default
Default value.
final_state_of_charge • StateOfCharge
Desired final amount of energy in a battery at the and of a trip. The value must be between 0 and 60% of the vehicle battery.capacity. If not provided—or if the specified value is below the safe risk margin—the safe risk margin is used by default.
value • Float
Value of the state of charge of the vehicle.
type • StateOfChargeUnit
Preferred unit for the vehicle's state of charge.
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.
default
Default value.
temperature • Temperature
Temperature of the battery.
value • Float
Value of the temperature.
type • TemperatureUnit
Preferred unit for the temperature.
Show TemperatureUnit enum values
Celsius
Return the temperature in Celsius.
Fahrenheit
Return the temperature in Fahrenheit.
current • Float
Battery current in ampere.
voltage • Float
Battery voltage in volts.
power • Float
Value of the positive or negative power, in kWh. When negative, the vehicle is charging.
is_charging • Boolean
Flag indicating 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 • Float
Minimum desired power of chargers, in kWh.
risk_margin • Int
Minimum remaining state of charge at charging stops, expressed as a percentage. The value must be between 0 and 60. If not provided, the project configuration value is used.
connectors • RouteVehicleChargingConnector
Supported connectors. If not specified, it defaults to the vehicle's 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.
maximum_charge_speed • ChargeSpeed
Maximum charging speed for this plug.
value • Float
Value of the charge speed of the battery.
type • ChargeSpeedUnit
Preferred unit for the battery's charge speed.
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.
default
Default value.
adapters • RouteVehicleChargingConnector
Supported adapters. If not specified, adapters will not be considered.
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.
maximum_charge_speed • ChargeSpeed
Maximum charging speed for this plug.
value • Float
Value of the charge speed of the battery.
type • ChargeSpeedUnit
Preferred unit for the battery's charge speed.
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.
default
Default value.
tire_pressure • TirePressure
Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right.
value • Float
Values for the tire pressure, ordered from front right to front left, then rear left to rear right.
type • PressureUnit
Preferred unit for the tire pressure.
Show PressureUnit enum values
bar
Return the pressure in bar.
pounds_per_square_inch
Return the pressure in pounds per square inch.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
default
Default value.
odometer • Odometer
Value of the vehicle's odometer.
value • Float
Value of the vehicle's odometer.
type • DistanceUnit
Preferred unit for the vehicle's odometer.
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.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
default
Default value.
auxiliary_consumption • AuxiliaryConsumption
Value of the auxiliary power consumption of the vehicle.
value • Float
Value of the vehicle's auxiliary power consumption.
type • AuxiliaryConsumptionUnit
Preferred unit for the vehicle's auxiliary power consumption.
Show AuxiliaryConsumptionUnit enum values
kilowatt_hour
Return the auxiliary consumption in kilowatt hours.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
default
Default value.
climate • Boolean
Flag indicating if climate control is on.
heat_pump • HeatPumpMode
Vehicle Heat Pump configuration.
Show HeatPumpMode enum values
default
Default to the vehicle configuration.
installed
Vehicle has it installed.
none
Vehicle doesn't have it installed.
cabin • RouteVehicleCabin
Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true.
is_preconditioned • Boolean
Flag indicating if the vehicle cabin was preconditioned for the desired temperature.
desired_temperature • Temperature
Desired cabin temperature. Default is 20 degrees Celsius or 68 degrees Fahrenheit.
value • Float
Value of the temperature.
type • TemperatureUnit
Preferred unit for the temperature.
Show TemperatureUnit enum values
Celsius
Return the temperature in Celsius.
Fahrenheit
Return the temperature in Fahrenheit.
motor_rpm • Int
Revolutions per minute of the motor, a measure of the rotational speed of the motor's rotor component.
outside_temperature • OutsideTemperature
Value of the outside temperature.
value • Float
Value of the temperature.
type • TemperatureUnit
Preferred unit for the outside 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.
default
Default value.
is_parked • Boolean
Flag indicating if a vehicle is in park, neutral, or turned off.
vehicle_speed • VehicleSpeed
Value of the vehicle's speed.
value • Float
Value of the vehicle speed.
type • SpeedUnit
Preferred unit for the vehicle's speed.
Show SpeedUnit enum values
kilometers_per_hour
Return the speed in kilometers per hour.
miles_per_hour
Return the 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.
default
Default value.
heading • Float
Current heading in degrees.
origin • RouteOriginFeaturePoint
Origin of a route.
id • ID
ID of the feature.
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 • RouteOriginProperties
Optional object where additional properties can be specified.
location • RoutePropertiesLocation
Data about the origin location.
name • String
Name that should overwrite the name that is automatically assigned to this location (for example: address or station name).
vehicle • RoutePropertiesVehicle
Vehicle data at the origin location.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • TotalOccupantWeight
Combined weight of the occupants. This can only be used in combination with occupants.
value • Float
Value of the combined weight of the occupants.
type • WeightUnit
Preferred unit for the current weight of the occupants.
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
default
Default value.
total_cargo_weight • TotalCargoWeight
Weight of the cargo.
value • Float
Value of the current weight of the cargo.
type • WeightUnit
Preferred unit for the current weight of the cargo.
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
default
Default value.
destination • RouteDestinationFeaturePoint
Destination of a route.
id • ID
ID of the feature.
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 • RouteDestinationProperties
Additional feature properties.
location • RoutePropertiesLocation
Data about the destination location.
name • String
Name that should overwrite the name that is automatically assigned to this location (for example: address or station name).
station • RoutePropertiesStation
Data about the destination station.
station_id • ID
ID of the station. When provided and valid, the coordinates of this station will be used.
external_station_id • ID
External ID of the station. When provided and valid, the coordinates of this station will be used.
stop_duration • Int
Duration to stay at the station, in seconds. Includes charging time and charging penalty. When not provided, the duration is optimized based on the vehicle’s charging needs and selected charging mode.
via • RouteViaFeaturePoint
Via points of a route.
id • ID
ID of the feature.
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 • RouteViaProperties
Additional feature properties for via. If a station.id or station.external_id are provided, it will be treated as a charging stop. If omitted or location.name is provided, the stop is treated as a non-charging stop location.
location • RoutePropertiesViaLocation
Location data of the via point.
name • String
Name that should overwrite the name that is automatically assigned to this location (for example: address or station name).
stop_duration • Int
Duration to stay at this point, in seconds.
vehicle • RoutePropertiesVehicle
Vehicle data of the via point.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • TotalOccupantWeight
Combined weight of the occupants. This can only be used in combination with occupants.
value • Float
Value of the combined weight of the occupants.
type • WeightUnit
Preferred unit for the current weight of the occupants.
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
default
Default value.
total_cargo_weight • TotalCargoWeight
Weight of the cargo.
value • Float
Value of the current weight of the cargo.
type • WeightUnit
Preferred unit for the current weight of the cargo.
Show WeightUnit enum values
kilogram
Return the weight in kilograms.
pound
Return the weight in pounds.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
default
Default value.
station • RoutePropertiesStation
Station data of the via point.
station_id • ID
ID of the station. When provided and valid, the coordinates of this station will be used.
external_station_id • ID
External ID of the station. When provided and valid, the coordinates of this station will be used.
stop_duration • Int
Duration to stay at the station, in seconds. Includes charging time and charging penalty. When not provided, the duration is optimized based on the vehicle’s charging needs and selected charging mode.
operators • RouteOperatorPreferences
Operator preferences for a route. When provided, prefers routes that use higher order operators.
ranking • RouteOperatorPreferencesRanking
Ranking of an operator with multiple levels, each level having its own penalty value.
type • RouteOperatorsType
Flag indicating if an operator should be preferred or required.
Show RouteOperatorsType enum values
none
Operators ranking will not be taken into account if no type is given.
preferred
Operators given in the operators ranking will be preferred when calculating routes.
required
Operators given in the operators ranking will be required when calculating routes, all other operators will be ignored.
levels • RouteOperatorPreferencesRankingLevels
Ranking levels for operator ranking.
low • RouteOperatorsValue
Least significant level for operators ranking.
id • ID
ID of an operator.
countries • CountryCodeAlpha2
List of countries in which the operator should be preferred/excluded. When omitted the operator will be preferred/excluded in every country.
Show CountryCodeAlpha2 enum values
AA
AD
AE
AF
AG
AI
AL
AM
AN
AO
AQ
AR
AS
AT
AU
AW
AX
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BL
BM
BN
BO
BQ
BR
BS
BT
BV
BW
BY
BZ
CA
CC
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CW
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
EH
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GG
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HM
HN
HR
HT
HU
ID
IE
IL
IM
IN
IO
IQ
IR
IS
IT
JE
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MF
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PN
PR
PS
PT
PW
PY
QA
RE
RKS
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SJ
SK
SL
SM
SN
SO
SR
SS
ST
SV
SX
SY
SZ
TC
TD
TF
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
XK
YE
YT
ZA
ZM
ZW
medium • RouteOperatorsValue
Medium level for operators ranking.
id • ID
ID of an operator.
countries • CountryCodeAlpha2
List of countries in which the operator should be preferred/excluded. When omitted the operator will be preferred/excluded in every country.
Show CountryCodeAlpha2 enum values
AA
AD
AE
AF
AG
AI
AL
AM
AN
AO
AQ
AR
AS
AT
AU
AW
AX
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BL
BM
BN
BO
BQ
BR
BS
BT
BV
BW
BY
BZ
CA
CC
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CW
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
EH
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GG
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HM
HN
HR
HT
HU
ID
IE
IL
IM
IN
IO
IQ
IR
IS
IT
JE
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MF
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PN
PR
PS
PT
PW
PY
QA
RE
RKS
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SJ
SK
SL
SM
SN
SO
SR
SS
ST
SV
SX
SY
SZ
TC
TD
TF
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
XK
YE
YT
ZA
ZM
ZW
high • RouteOperatorsValue
Most significant level for operator ranking.
id • ID
ID of an operator.
countries • CountryCodeAlpha2
List of countries in which the operator should be preferred/excluded. When omitted the operator will be preferred/excluded in every country.
Show CountryCodeAlpha2 enum values
AA
AD
AE
AF
AG
AI
AL
AM
AN
AO
AQ
AR
AS
AT
AU
AW
AX
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BL
BM
BN
BO
BQ
BR
BS
BT
BV
BW
BY
BZ
CA
CC
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CW
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
EH
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GG
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HM
HN
HR
HT
HU
ID
IE
IL
IM
IN
IO
IQ
IR
IS
IT
JE
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MF
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PN
PR
PS
PT
PW
PY
QA
RE
RKS
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SJ
SK
SL
SM
SN
SO
SR
SS
ST
SV
SX
SY
SZ
TC
TD
TF
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
XK
YE
YT
ZA
ZM
ZW
exclude • RouteOperatorsValue
Operators that should be excluded for a route calculation.
id • ID
ID of an operator.
countries • CountryCodeAlpha2
List of countries in which the operator should be preferred/excluded. When omitted the operator will be preferred/excluded in every country.
Show CountryCodeAlpha2 enum values
AA
AD
AE
AF
AG
AI
AL
AM
AN
AO
AQ
AR
AS
AT
AU
AW
AX
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BL
BM
BN
BO
BQ
BR
BS
BT
BV
BW
BY
BZ
CA
CC
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CS
CU
CV
CW
CX
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
EH
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GG
GH
GI
GL
GM
GN
GP
GQ
GR
GS
GT
GU
GW
GY
HK
HM
HN
HR
HT
HU
ID
IE
IL
IM
IN
IO
IQ
IR
IS
IT
JE
JM
JO
JP
KE
KG
KH
KI
KM
KN
KP
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MF
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PN
PR
PS
PT
PW
PY
QA
RE
RKS
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SJ
SK
SL
SM
SN
SO
SR
SS
ST
SV
SX
SY
SZ
TC
TD
TF
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
UM
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
XK
YE
YT
ZA
ZM
ZW
season • RouteSeason
Deprecated
Season of a route.
Show RouteSeason enum values
summer
We suppose it is summer and we have the best weather conditions.
winter
We suppose it is winter and we have the worst weather conditions.
current
We fetch the current weather conditions.
alternative_station_radius • AlternativeStationRadius
Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit.
value • Float
Value of the alternative station radius.
type • DistanceUnit
Preferred unit for the alternative station radius.
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.
source • TelemetryInputSource
Source of inputted data.
Show TelemetryInputSource enum values
manual
Manually inputted value.
telemetry
Value from the vehicle's telemetry.
default
Default value.
departure_time • DateTime
Route departure time. Used to calculate the expected arrival time and, if set in the past, to apply historical weather data.
avoid • RouteAvoid
[BETA] List of route features to avoid in a route. This is a best-effort preference; depending on the available routes, some features may not be fully avoidable.
Show RouteAvoid enum values
toll_road
ferry
maximum_speed • MaximumSpeed
[BETA] User-defined maximum speed used for this route, if provided.
value • Int
Numeric value of the user-defined maximum speed.
type • SpeedUnit
Unit in which speed is measured.
Show SpeedUnit enum values
kilometers_per_hour
Return the speed in kilometers per hour.
miles_per_hour
Return the speed in miles per hour.
weather • RouteWeather
Weather configuration for the route. Defined by a preset or custom weather conditions.
type • WeatherType
Weather configuration applied to the route.
Show WeatherType enum values
summer
Fixed seasonal preset representing typical summer weather conditions. Can't be used in combination with weather.custom.
winter
Fixed seasonal preset representing typical winter weather conditions. Can't be used in combination with weather.custom.
actual
A dynamic preset that uses real weather data based on the route's departure time. Can't be used in combination with weather.custom.
custom
Must be used in combination with weather.custom object.
custom • RouteWeatherCustomConditions
[BETA] Custom weather conditions applied to the route. Only present when 'type' is set to 'CUSTOM'.
temperature • Temperature
Average ambient temperature estimated along the route.
value • Float
Value of the temperature.
type • TemperatureUnit
Preferred unit for the temperature.
Show TemperatureUnit enum values
Celsius
Return the temperature in Celsius.
Fahrenheit
Return the temperature in Fahrenheit.
air_pressure • AirPressure
Atmospheric pressure along the route.
value • Float
Value of the atmospheric pressure.
type • AirPressureUnit
Atmospheric pressure unit.
Show AirPressureUnit enum values
millibar
solar_irradiance • SolarIrradiance
Solar irradiance along the route.
value • Float
Value of the solar irradiance.
type • SolarIrradianceUnit
Solar irradiance unit.
Show SolarIrradianceUnit enum values
watts_per_square_meter
polyline • String
Polyline containing encoded coordinates.
Show arguments
decimals • PolylineInputDecimals
Polyline decimals
Default • five
Show PolylineInputDecimals enum values
five
six
status • NavigationStatus
The status of a navigation session. The status can be driving, charging, finished, or error.
Show NavigationStatus enum values
driving
Vehicle is driving.
charging
Vehicle is charging.
finished
Navigation session is completed (either manually or automatically 48 hours after the last update).
error
Failed to update navigation session due to route error or not found.
meta • NavigationMeta
Navigation meta information.
created_at • DateTime
Creation time of the navigation session.
updated_at • DateTime
Last updated time of the navigation session.
Response
A response can either contain a data or an
errors object. The response header will always return
200 as a status code.
Data object
When successful, a data object will be returned with the
requested fields. If there are no fields present the
data object will return the operation name with the
appropriate return type. If the operation was a query, this output
will be an object of the schema’s query root type; if the operation
was a mutation, this output will be an object of the schema’s mutation
root type.
Error object
If unsuccessful, an errors object will be returned with
more details in the extensions object. The error object
can contain any of the following objects.
Error
NAVIGATION_INVALID_ROUTE_STATUS
Cannot start a navigation session for a route with status '$ROUTESTATUS'.
Error
NAVIGATION_NOT_FOUND
No navigation session was found with the provided ID.
Error
OPERATION_NOT_ALLOWED
You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.
Error
ROUTE_POLYLINE_INVALID_DECIMALS
Value for decimals number is not valid. Allowed values are 5 or 6.