Subscribe to route updates
After retrieving a route ID through the route mutation, a route subscription can be started to obtain the polyline and other route details. Because longer routes take some time to finish we recommend using a GraphQL subscription as described in the introduction.
Subscription
The subscription service needs to be initiated with a route ID. From there on it will start calculating and, based on your interval, provide you with a route status. For all possible statuses, see the response section of this document.
Finally, if the route supported any additional options they can now be requested on the subscription response. An overview of all the possible options can be found on the query route details page.
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.
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.
polyline • String
Polyline containing encoded coordinates.
Show arguments
decimals • PolylineInputDecimals
Polyline decimals
Default • five
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.
maximum_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.
Show arguments
currency • Currency
Currency to convert the amount to.
Default • EUR
Show Currency enum values
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BRL
BSD
BTN
BWP
BYN
BYR
BZD
CAD
CDF
CHF
CLF
CLP
CNY
COP
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EGP
ERN
ETB
EUR
FJD
FKP
GBP
GEL
GGP
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
IMP
INR
IQD
IRR
ISK
JEP
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LTL
LVL
LYD
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MRO
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SRD
STD
SVC
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TWD
TZS
UAH
UGX
USD
UYU
UZS
VEF
VND
VUV
WST
XAF
XAG
XAU
XCD
XDR
XOF
XPF
YER
ZAR
ZMK
ZMW
ZWL
XPT
XPD
BTC
ETH
BNB
XRP
SOL
DOT
AVAX
MATIC
LTC
ADA
average_gas_price • Float
Average gas price with which the calculation was made.
Show arguments
currency • Currency
Currency to convert the amount to.
Default • EUR
Show Currency enum values
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BRL
BSD
BTN
BWP
BYN
BYR
BZD
CAD
CDF
CHF
CLF
CLP
CNY
COP
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EGP
ERN
ETB
EUR
FJD
FKP
GBP
GEL
GGP
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
IMP
INR
IQD
IRR
ISK
JEP
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LTL
LVL
LYD
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MRO
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SRD
STD
SVC
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TWD
TZS
UAH
UGX
USD
UYU
UZS
VEF
VND
VUV
WST
XAF
XAG
XAU
XCD
XDR
XOF
XPF
YER
ZAR
ZMK
ZMW
ZWL
XPT
XPD
BTC
ETH
BNB
XRP
SOL
DOT
AVAX
MATIC
LTC
ADA
average_energy_price • Float
Average energy price with which the calculation was made.
Show arguments
currency • Currency
Currency to convert the amount to.
Default • EUR
Show Currency enum values
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BDT
BGN
BHD
BIF
BMD
BND
BOB
BRL
BSD
BTN
BWP
BYN
BYR
BZD
CAD
CDF
CHF
CLF
CLP
CNY
COP
CRC
CUC
CUP
CVE
CZK
DJF
DKK
DOP
DZD
EGP
ERN
ETB
EUR
FJD
FKP
GBP
GEL
GGP
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
IMP
INR
IQD
IRR
ISK
JEP
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LKR
LRD
LSL
LTL
LVL
LYD
MAD
MDL
MGA
MKD
MMK
MNT
MOP
MRO
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOS
SRD
STD
SVC
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TWD
TZS
UAH
UGX
USD
UYU
UZS
VEF
VND
VUV
WST
XAF
XAG
XAU
XCD
XDR
XOF
XPF
YER
ZAR
ZMK
ZMW
ZWL
XPT
XPD
BTC
ETH
BNB
XRP
SOL
DOT
AVAX
MATIC
LTC
ADA
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.
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 • 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 • Int
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 combined 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.
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 • 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 • Int
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 combined 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
station • RouteDetailsLegStation
Information about the station at the origin of this leg.
station_id • ID
ID of a station.
evse_id • ID
ID of the EVSE that was selected in a route.
connector_id • ID
ID of the connector that was selected in a route.
polyline • String
Polyline containing encoded coordinates.
Show arguments
decimals • PolylineInputDecimals
Polyline decimals
Default • five
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 • RouteDetailsLegSectionFeaturePoint
Location of the maneuver.
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 • RouteDetailsLegSectionFeaturePointProperties
Properties of the feature.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • Float
Value of the combined 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.
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 • RouteDetailsLegSectionFeaturePointProperties
Properties of the feature.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • Float
Value of the combined 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.
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 • RouteDetailsLegSectionFeaturePointProperties
Properties of the feature.
occupants • Int
Number of occupants present in the vehicle.
total_occupant_weight • Float
Value of the combined 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
Polyline decimals
Default • five
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 duration of a section, in seconds. The value will be 0 for walking sections.
consumption • Float
Total energy used in a section in kilowatt-hours. The value will be 0 for walking sections.
alternative_stations • RouteDetailsAlternativeStation
Alternative stations along a route within specified radius.
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 • OperatorRankingLevel
Ranking of an operator.
Show OperatorRankingLevel enum values
low
medium
high
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 charging stops required for this 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.
default
Default value.
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.
default
Default value.
final_state_of_charge • StateOfCharge
Minimum final battery state of charge. The value should be between 0 and 60% of the 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.
default
Default value.
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.
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 which 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 • Float
Minimum desired power of chargers, in kWh.
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.
maximum_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.
default
Default value.
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.
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 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.
default
Default value.
tire_pressure • TirePressure
Average tire pressures of all wheels, starting from the front side (right to left) and then to the rear.
value • Float
Values for the tire pressure, starting from the front side right to left and to the rear (FR, FL, RL, RR).
type • PressureUnit
Type of the value of 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
Type of the value of 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 auxiliary power consumption of the vehicle.
type • AuxiliaryConsumptionUnit
Type of auxiliary power consumption of the vehicle.
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 which indicates 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.
is_preconditioned • Boolean
Flag which indicates 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
Type of 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
Type of the 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 which indicates if 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
Type of the vehicle 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
Type of 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
Type of 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
Optional object where additional properties can be specified.
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.
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
Optional object where additional properties can be specified.
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
Type of 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
Type of 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.
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
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
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
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
Route operators that should be excluded.
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
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
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
Type of 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
Departure time of a route.
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
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_NOT_FOUND
No route was found with the provided ID.