Query

Unknown

Arguments

id· ID· required

Vehicles unique ID.

country· CountryCodeAlpha2

ISO-3166 alpha-2 country code to apply localization on vehicle data if available.

Fields

id· ID

Vehicles unique ID.

succesor_id· String

Internal ID of the successor vehicle trim.

naming· VehiclePremiumNaming

Naming of the vehicle.

connectors· VehicleConnector

Connectors available for the vehicle. Please note that for HEVs this will always be an empty array.

standard· ConnectorType

Connector type, known as connector standard in OCPI.

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.

power· Float

Usable electric power.

max_electric_power· Float

Maximum electric power.

time· Int

Time it takes to charge from 10 to 80% with a fast charger, shown in minutes.

speed· Float· deprecated

Charging speed.

charge_speed· Float

Charging speed.

charge· VehiclePremiumCharge

Charge details.

plug· VehiclePremiumChargePlug

Information about the main connector.

value· ConnectorType

Type of charge port on vehicle.

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.

is_estimated· Boolean

Indicates if value is an estimate.

location· String

Location of charge port.

second_plug· VehiclePremiumChargeSecondPlug

Information about vehicles secondary onboard charger.

standard· VehiclePremiumChargeStandardOBC

Information about the vehicle standard onboard charger.

option· VehiclePremiumChargeOptionOBC

Optional upgrade for the standard onboard charger when available.

alternative· VehiclePremiumChargeAlternativeOBC

Alternative upgrade for the standard onboard charger when available.

vehicle_to_everything· VehicleToEverything

Vehicle-to-everything charge support.

vehicle_to_load· VehicleToEverythingLoad

Information about Vehicle-to-Load.

vehicle_to_home· VehicleToEverythingHomeGrid

Information about Vehicle-to-Home.

vehicle_to_grid· VehicleToEverythingHomeGrid

Information about Vehicle-to-Grid.

fast_charge· VehiclePremiumFastCharge

Fast charge details.

plug· VehiclePremiumChargePlug

Details about the connector.

value· ConnectorType

Type of charge port on vehicle.

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.

is_estimated· Boolean

Indicates if value is an estimate.

location· String

Location of charge port.

power· VehiclePremiumChargePower

Power during fast charging from 10% to 80% SoC (optimal conditions, fastest charger).

charge_time· Float

Minutes needed to charge from 10% to 80%, with average charging power (optimal conditions, fastest charger).

charge_speed· Float

Charging speed during fast charging from 10% to 80% (optimal conditions, fastest charger).

is_optional· Boolean

Indicates if fast charge is optional in some markets/regions.

is_estimated· Boolean

Indicates what fields are estimated.

table· VehiclePremiumFastChargeTable

Charging details for fast charging.

has_autocharge· Boolean

Indicates if autocharge is available.

iso_15118_pnc_support· VehiclePlugAndChargeSupport

Status of Plug & Charge (PnC ISO15118) support for vehicle.

iso_15118_pnc_support_2· VehiclePlugAndChargeSupport

Status of Plug & Charge (PnC ISO15118) -2 protocol support for vehicle.

iso_15118_pnc_support_20· VehiclePlugAndChargeSupport

Status of Plug & Charge (PnC ISO15118) -20 protocol support for vehicle.

is_fastned_tested· Boolean

Indicates if the fastcharge data is based on a real-world test by Fastned.

adapters· VehicleConnector

Adapters of connectors available for a connectors of the vehicle. Please note that for HEVs this will always be an empty array.

standard· ConnectorType

Connector type, known as connector standard in OCPI.

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.

power· Float

Usable electric power.

max_electric_power· Float

Maximum electric power.

time· Int

Time it takes to charge from 10 to 80% with a fast charger, shown in minutes.

speed· Float· deprecated

Charging speed.

charge_speed· Float

Charging speed.

battery· VehiclePremiumBattery

Battery of the vehicle.

body· VehiclePremiumBody

Body of the vehicle.

length· Float

Length.

width· Float

Width with folded mirrors.

full_width· Float

Width of vehicle including mirrors.

height· Float

Height (average height for adjustable suspensions).

size_is_estimated· Boolean

Indicates if length/width/height fields are estimations.

wheelbase· Float

Wheelbase.

wheelbase_is_estimated· Boolean

Indicates if wheelbase field is estimated.

ground_clearance· Float

Ground clearance of a vehicle as specified by the OEM.

weight· VehicleBodyWeight

Weight (unladen EU).

weight_gvwr· VehicleBodyWeight

Maximum allowed vehicle weight with payload.

weight_gtw· VehicleBodyWeight

Maximum allowed vehicle and trailer weight with payload.

weight_payload· VehicleBodyWeight

Allowed payload weight.

weight_is_estimated· Boolean

Indicates if weight field is estimated.

weight_max_payload· Float

Maximum payload allowed for the vehicle.

boot_capacity· Float

Standard luggage capacity.

boot_front_capacity· Float

Storage capacity of front trunk/under the hood (frunk).

boot_capacity_max· Float

Maximum luggage capacity.

tow_hitch_compatible· Boolean

Indicates if a tow hitch/towbar can be fitted according to vehicle homologation.

tow_weight_unbraked· Float

Maximum unbraked towing weight.

tow_weight_braked· Float

Maximum braked towing weight.

tow_weight_is_estimated· Boolean

Indicates if tow weight fields are estimations.

tow_weight_vertical_load· Float

Maximum vertical load / noseweight on tow hitch according to vehicle homologation.

roof_load_max· Float

Maximum load on roof of the vehicle.

body_type· String

Body type, listed in local naming convention where applicable.

segment· String

Segment, listed in local naming convention where applicable.

seats· Int

Number of seats.

has_roofrails· Boolean

Indicates whether a vehicle has roof rails as a standard.

turning_circle· Float

Turning circle of the vehicle kerb-to-kerb.

vehicle_platform· String

Name of the vehicle platform used for vehicle (often abbreviated to indicate group platforms).

vehicle_platform_is_dedicated· Boolean

Indicates if the vehicle platform used for vehicle is a dedicated battery electric vehicle platform.

availability· VehiclePremiumAvailability

Availability of the vehicle.

pricing· VehiclePremiumPriceValueWithGrant

Starting price in the currency defined in the field argument. If not defined, it will return the starting price in the currency returned in the currency field.

drivetrain· VehiclePremiumDrivetrain

Drivetrain of the vehicle.

performance· VehiclePremiumPerformance

Performance of the vehicle.

range· VehiclePremiumRange

Range of the vehicle.

efficiency· VehiclePremiumEfficiency

Efficiency of the vehicle.

wltp· VehiclePremiumEfficiencyWLTP

Rated efficiency in WLTP combined cycle.

wltp_teh· VehiclePremiumEfficiencyWLTPTEH

Rated efficiency in WLTP combined cycle (TEH / least efficient trim).

nedc· VehiclePremiumEfficiencyNEDC

Rated efficiency in NEDC combined cycle.

provider· VehiclePremiumEfficiencyProvider

Vehicle efficiency based on provider range.

safety· VehiclePremiumSafety

Safety of the vehicle.

media· VehiclePremiumMedia

Media of the vehicle.

provider_details_url· String

URL for more details.

image· VehicleImage

Featured image of the vehicle from a 45-degree angle.

brand· VehicleImage· deprecated

Latest make logo.

make· VehicleImage

Latest make logo.

image_list· VehicleImage

All images of the vehicle.

video· VehicleVideo

Errors

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

operation_not_allowed
rate_limit_exceeded
vehicle_not_found
vehicle_premium_not_allowed

Was this helpful?