Amperage
Current amperage flowing to the electric vehicle during a charging session, measured in amps.
Current amperage flowing to the electric vehicle during a charging session, measured in amps.
{
"unit" : "amps" ,
"value" : 32
}
Max Amperage
The maximum available amps available to charge.
The maximum available amps available to charge.
{
"unit" : "amps" ,
"value" : 48
}
Amperage Requested
The requested amps to charge the vehicle.
The requested amps to charge the vehicle.
{
"unit" : "amps" ,
"value" : 32
}
Charge Limits
Array of charge limit configurations, each representing a different context (global, location-based, or connector-based).
Show Array item properties
The type of charge limit configuration. ‘global’ applies universally, ‘location’ is specific to a location, and ‘connector’ is specific to a charging connector type.
The maximum state of charge (SoC) limit configured for this context, expressed as a percentage (0-100).
Additional context for location or connector-based charge limits. Null for global configurations.
Show condition properties
Name of the location or charging station where this limit applies.
Street address of the location where this limit applies.
Geographic latitude coordinate of the location where this limit applies.
Geographic longitude coordinate of the location where this limit applies.
Type of charging connector where this limit applies (only used when type is ‘connector’).
{
"values" : [
{
"type" : "global" ,
"limit" : 80 ,
"condition" : null
},
{
"type" : "location" ,
"limit" : 90 ,
"condition" : {
"name" : "Home" ,
"address" : "123 Main St" ,
"latitude" : 37.7749 ,
"longitude" : -122.4194
}
}
]
}
Charge Port Status Color
Current status indicator color displayed on or around the vehicle’s charging port.
Charge Rate
Current rate at which range is being added to the vehicle during an active charging session
Current rate at which range is being added to the vehicle during an active charging session
{
"unit" : "miles_per_hour" ,
"value" : 25
}
Records
Array of individual charging session records, each representing a completed or ongoing charging event.
Show Array item properties
Unique OEM identifier assigned to the specific charging session.
Detailed breakdown of the charging session costs.
Three-letter currency code (e.g., ‘USD’, ‘EUR’) representing the monetary unit used for the charging session transaction.
Cost specifically for the electrical energy consumed during the charging session.
Additional non-energy related charges (e.g., connection fees, parking fees) associated with the charging session.
ISO-8601 timestamp marking when a charging session was completed or terminated.
Details about where the charging session took place.
Descriptive name of the charging location (e.g., ‘Home Charger’, ‘Public Station 123’).
Street address of the charging location.
Geographic latitude coordinate of the charging location.
Geographic longitude coordinate of the charging location.
ISO-8601 timestamp marking when a charging session was initiated.
Total amount of electrical energy delivered during the charging session, measured in kilowatt-hours (kWh).
Identifier for the type of charging connector used (e.g., ‘J1772’, ‘CCS’, ‘CHAdeMO’).
Indicates whether the charging occurred at a public charging station (true) or private location (false).
Battery’s state of charge (0-100%) at the end of the charging session.
Battery’s state of charge (0-100%) at the start of the charging session.
{
"values" : [
{
"id" : "CHG123" ,
"cost" : {
"currency" : "USD" ,
"otherAmount" : 2 ,
"energyAmount" : 10.5
},
"endTime" : "2023-10-15T08:00:00Z" ,
"location" : {
"name" : "Home Charger" ,
"address" : "123 Main St" ,
"latitude" : 37.7749 ,
"longitude" : -122.4194
},
"startTime" : "2023-10-15T00:00:00Z" ,
"energyAdded" : 40.5 ,
"connectorType" : "J1772" ,
"isPublicCharger" : false ,
"endStateOfCharge" : 90 ,
"startStateOfCharge" : 20
}
]
}
Charge Timers
Array of charging timer configurations, each defining either scheduled charging times or departure times.
Show Array item properties
The type of charging timer configuration. ‘global’ applies universally, ‘location’ is specific to a location, and ‘connector’ is specific to a charging connector type.
Additional context for location or connector-based charging timers. Null for global configurations.
Show condition properties
Name of the location or charging station where this timer configuration applies.
Street address of the location where this timer configuration applies.
Geographic latitude coordinate of the location where this timer configuration applies.
Geographic longitude coordinate of the location where this timer configuration applies.
Type of charging connector where this timer configuration applies (only used when type is ‘connector’).
Array of time windows during which charging should occur, defined by start and end times on specific days.
Show Array item properties
The time when the charging window should end, in 24-hour format (HH:MM:SS).
List of days of the week when this charging schedule should be active.
The time when the charging window should begin, in 24-hour format (HH:MM:SS).
Array of target departure times when the vehicle should be charged and ready to use.
Show Array item properties
List of days of the week when this departure timer should be active.
The target time when the vehicle should be fully charged and ready, in 24-hour format (HH:MM:SS).
Indicates whether the vehicle manufacturer’s smart charging optimization features are enabled for this timer configuration.
Charger Phases
The number of phases available from the connected charger.
The number of phases available from the connected charger.
{
"unit" : "count" ,
"value" : 3
}
Charging Connector Type
Identifier for the type of charging connector/inlet equipped on the vehicle.
Detailed Charging Status
String value that provides detailed information about the current state of the charging process.
{
"value" : "CHARGING_AC"
}
Energy Added
Cumulative amount of electrical energy delivered to the vehicle during the current or most recent charging session, measured in kilowatt-hours (kWh).
Cumulative amount of electrical energy delivered to the vehicle during the current or most recent charging session, measured in kilowatt-hours (kWh).
{
"unit" : "kilowatt_hours" ,
"value" : 25.5
}
Fast Charger Type
Identifier for the specific DC fast charging standard currently connected to the vehicle. Indicates the protocol being used for high-power charging
Is Charging
Boolean indicator that shows whether the electric vehicle is actively receiving power from a charging station or outlet.
Is Charging Cable Connected
Boolean indicator that shows whether a charging cable is physically connected to the vehicle’s charging port.
Is Charging Cable Latched
Boolean indicator that shows whether the charging cable is securely locked to the vehicle’s charging port.
Is Charging Port Flap Open
Boolean indicator that shows whether the vehicle’s charging port access door or flap is currently open.
Is Fast Charger Present
Boolean indicator that shows whether the vehicle is connected to a DC fast charging station.
Time To Complete
Estimated time remaining until the charging session reaches the activeLimit in minutes.
Estimated time remaining until the charging session reaches the activeLimit in minutes.
Voltage
Current voltage level being supplied to the electric vehicle during a charging session, measured in volts.
Current voltage level being supplied to the electric vehicle during a charging session, measured in volts.
{
"unit" : "volts" ,
"value" : 240
}
Wattage
Current power delivery rate to the electric vehicle during a charging session, measured in watts.
Current power delivery rate to the electric vehicle during a charging session, measured in watts.
{
"unit" : "watts" ,
"value" : 250
}