Subscription

Unknown

Fields

id· ID

ID of a route calculation.

status· RouteStatus

Status of a route.

recommended· RouteDetails

Recommended route.

id· ID

ID of a route computation.

distance· Float

Total distance of a route.

durations· RouteDetailsDurations

Aggregation of all durations of a route.

consumption· Float

Total energy used for a route in kilowatt hours. For HEVs and PHEVs this field will return null.

range_at_origin· Float

Range available at the start of a trip. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null.

range_at_destination· Float

Range available at the end of a trip. Note: The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null.

polyline· String

Polyline containing encoded coordinates.

path_plot· RouteDetailsPathSegment

Path elevation, distance, duration, consumption and speed values, grouped into 100 segments.

elevation· RouteDetailsElevation

Details about elevation on a route.

savings· RouteDetailsSavings

Money saving information.

legs· RouteDetailsLeg

Legs of a route.

distance· Float

Distance from the start to the end of a leg.

durations· RouteDetailsDurations

Aggregation of all durations of a route leg.

consumption· Float

Total energy used in a leg in kilowatt hours. For HEVs and PHEVs this field will return null.

origin· RouteDetailsLegFeaturePoint

Origin point location.

destination· RouteDetailsLegFeaturePoint

Destination point location.

range_at_origin· Float

Range at the start of a leg. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null.

range_at_destination· Float

Range available at the end of a leg. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null.

range_after_charge· Float

Range after charging on the leg. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null.

type· RouteDetailsLegType

Type of a leg.

station· RouteDetailsLegStation

Information about the station at the destination of a leg.

polyline· String

Polyline containing encoded coordinates.

tags· RouteDetailsTag

Aggregation of tags over the current leg. Tags are further subdivided over individual sections and maneuvers.

maneuvers· RouteDetailsManeuver

Maneuvers of a leg - used to generate turn-by-turn instructions.

sections· RouteDetailsLegSection

Road sections of a leg - divided by means of transportation.

type· RouteDetailsLegSectionType

Section type.

origin· RouteDetailsLegSectionFeaturePoint

Origin point.

destination· RouteDetailsLegSectionFeaturePoint

Destination point.

tags· RouteDetailsTag

Aggregation of tags over the current section.

polyline· String

Polyline containing encoded coordinates.

distance· Float

Distance from the start to the end of a section.

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.

traffic· RouteDetailsLegSectionTraffic· beta

Information regarding traffic conditions along the leg's section. Available for routes created with traffic_aware set to true.

warnings· RouteDetailsLegWarning· beta

Warnings that certain conditions specified in a route mutation are not respected.

traffic· RouteDetailsLegTraffic· beta

Traffic conditions along the leg. Only returns data if `traffic_aware` is set to true in the `createRoute` mutation.

alternative_stations· RouteDetailsAlternativeStation

Alternative stations along a route within a specified radius. Includes stations from preferred/required/avoided operators but excludes stations from excluded operators. This list is only populated if `alternative_station_radius` was specified in the `createRoute` mutation.

tags· RouteDetailsTag

Aggregation of tags over the current RouteDetails. Tags are available on legs and further subdivided over individual sections and maneuvers.

charges· Int

Number of charging stops required for this route.

warnings· RouteWarning· beta

Warnings that certain conditions specified in a route mutation are not respected.

traffic· RouteDetailsTraffic· beta

Traffic conditions along the route. Only returns data if `traffic_aware` is set to true in the `createRoute` mutation.

alternatives· RouteDetails· beta

Alternative routes.

id· ID

ID of a route computation.

distance· Float

Total distance of a route.

durations· RouteDetailsDurations

Aggregation of all durations of a route.

consumption· Float

Total energy used for a route in kilowatt hours. For HEVs and PHEVs this field will return null.

range_at_origin· Float

range_at_destination· Float

polyline· String

Polyline containing encoded coordinates.

path_plot· RouteDetailsPathSegment

Path elevation, distance, duration, consumption and speed values, grouped into 100 segments.

elevation· RouteDetailsElevation

Details about elevation on a route.

savings· RouteDetailsSavings

Money saving information.

legs· RouteDetailsLeg

Legs of a route.

distance· Float

Distance from the start to the end of a leg.

durations· RouteDetailsDurations

Aggregation of all durations of a route leg.

consumption· Float

Total energy used in a leg in kilowatt hours. For HEVs and PHEVs this field will return null.

origin· RouteDetailsLegFeaturePoint

Origin point location.

destination· RouteDetailsLegFeaturePoint

Destination point location.

range_at_origin· Float

range_at_destination· Float

range_after_charge· Float

type· RouteDetailsLegType

Type of a leg.

station· RouteDetailsLegStation

Information about the station at the destination of a leg.

polyline· String

Polyline containing encoded coordinates.

tags· RouteDetailsTag

Aggregation of tags over the current leg. Tags are further subdivided over individual sections and maneuvers.

maneuvers· RouteDetailsManeuver

Maneuvers of a leg - used to generate turn-by-turn instructions.

sections· RouteDetailsLegSection

Road sections of a leg - divided by means of transportation.

type· RouteDetailsLegSectionType

Section type.

origin· RouteDetailsLegSectionFeaturePoint

Origin point.

destination· RouteDetailsLegSectionFeaturePoint

Destination point.

tags· RouteDetailsTag

Aggregation of tags over the current section.

polyline· String

Polyline containing encoded coordinates.

distance· Float

Distance from the start to the end of a section.

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.

traffic· RouteDetailsLegSectionTraffic· beta

Information regarding traffic conditions along the leg's section. Available for routes created with traffic_aware set to true.

warnings· RouteDetailsLegWarning· beta

Warnings that certain conditions specified in a route mutation are not respected.

traffic· RouteDetailsLegTraffic· beta

Traffic conditions along the leg. Only returns data if `traffic_aware` is set to true in the `createRoute` mutation.

alternative_stations· RouteDetailsAlternativeStation

tags· RouteDetailsTag

Aggregation of tags over the current RouteDetails. Tags are available on legs and further subdivided over individual sections and maneuvers.

charges· Int

Number of charging stops required for this route.

warnings· RouteWarning· beta

Warnings that certain conditions specified in a route mutation are not respected.

traffic· RouteDetailsTraffic· beta

Traffic conditions along the route. Only returns data if `traffic_aware` is set to true in the `createRoute` mutation.

meta· RouteMetadata

Meta data for a route.

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

Usable capacity of a battery used to compute a route. The value must be between 50% and 150% of a vehicle's baseline battery capacity. If not provided, the vehicle's full usable capacity by default.

state_of_charge· StateOfCharge

Current amount of energy in a battery. If not provided, battery is assumed to be fully charged.

final_state_of_charge· StateOfCharge

Desired final amount of energy in a battery at the end of a trip. The value must be between 0 and 80% of the vehicle's battery capacity. If not provided, or if the specified value is below the safe risk margin, the safe risk margin is used by default.

temperature· Temperature

Temperature of the battery.

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 state of charge.

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.

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.

GBT_AC

Guobiao GB/T 20234.2 AC socket/connector.

GBT_DC

Guobiao GB/T 20234.3 DC connector.

maximum_charge_speed· ChargeSpeed

Maximum charging speed for this plug.

adapters· RouteVehicleChargingConnector

Supported adapters. If not specified, adapters will not be considered.

standard· ConnectorType

Type of the plug.

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.

GBT_AC

Guobiao GB/T 20234.2 AC socket/connector.

GBT_DC

Guobiao GB/T 20234.3 DC connector.

maximum_charge_speed· ChargeSpeed

Maximum charging speed for this plug.

maximum_state_of_charge· Int

Maximum state of charge (%) the vehicle can reach at any charging stop. If not specified defaults to 80%.

tire_pressure· TirePressure

Tire pressures of all wheels, ordered from front right to front left, then rear left to rear right.

odometer· Odometer

Value of the vehicle's odometer.

auxiliary_consumption· AuxiliaryConsumption

Value of the auxiliary power consumption of the vehicle.

climate· Boolean

Flag indicating if climate control is on.

heat_pump· HeatPumpMode

Vehicle Heat Pump configuration.

cabin· RouteVehicleCabin

Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true.

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.

is_parked· Boolean

Flag indicating if a vehicle is in park, neutral, or turned off.

vehicle_speed· VehicleSpeed

Value of the vehicle's speed.

heading· Float

Current heading in degrees.

origin· RouteOriginFeaturePoint

Origin of a route.

destination· RouteDestinationFeaturePoint

Destination of a route.

via· RouteViaFeaturePoint

Via points of a route.

id· ID

ID of the feature.

type· FeatureType

Feature type.

geometry· Point

Geometry of the feature.

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.

operators· RouteOperatorPreferences

Operator preferences for a route.

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.

levels· RouteOperatorPreferencesRankingLevels

Ranking levels for operator ranking.

low· RouteOperatorsValue

Least significant level for operators ranking.

medium· RouteOperatorsValue

Medium level for operators ranking.

high· RouteOperatorsValue

Most significant level for operator ranking.

exclude· RouteOperatorsValue

Operators that should be excluded for a route calculation.

avoid· RouteOperatorsValue

Operators that should be avoided, but not excluded, for a route calculation.

season· RouteSeason· deprecated

Season of a route.

alternative_station_radius· AlternativeStationRadius

Search radius for alternative charging stations along the route. Accepts a value between 500 and 5000 meters (or unit equivalent). If not specified, disables the alternative station search for the generated route.

alternative_routes· Int· beta

Number of alternative routes to request.

departure_time· DateTime

Route departure time.

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.

driving_preferences· RouteDrivingPreferences· beta

Configuration options for the route's driving conditions. Includes factors to adjust average speed, set a maximum speed, and define a base driving style. If not specified, no adjustments are applied.

weather· RouteWeather

Weather configuration for the route. Defined by a preset or custom weather conditions.

station_preferences· RouteStationPreferences

Charging stations preferences for route calculation.

traffic_aware· Boolean· beta

Indicates whether current traffic conditions were considered during route calculation. This feature is disabled by default and requires explicit enablement for your project. Please contact Chargetrip support for more information.

Errors

Operations can fail. To handle all errors correctly, consider implementing the following error scenario’s.

operation_not_allowed
rate_limit_exceeded
route_not_found

Was this helpful?

Unknown

Arguments

Fields

Errors