Amperage

unit
string
Current amperage flowing to the electric vehicle during a charging session, measured in amps.
value
number
Current amperage flowing to the electric vehicle during a charging session, measured in amps.
Example
{
  "unit": "amps",
  "value": 32
}

Max Amperage

unit
string
The maximum available amps available to charge.
value
number
The maximum available amps available to charge.
Example
{
  "unit": "amps",
  "value": 48
}

Amperage Requested

unit
string
The requested amps to charge the vehicle.
value
number
The requested amps to charge the vehicle.
Example
{
  "unit": "amps",
  "value": 32
}

Charge Limits

values
array
Array of charge limit configurations, each representing a different context (global, location-based, or connector-based).
Example
{
  "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

value
string
Current status indicator color displayed on or around the vehicle’s charging port.
Example
{
  "value": "GREEN"
}

Charge Rate

unit
string
Current rate at which range is being added to the vehicle during an active charging session
value
number
Current rate at which range is being added to the vehicle during an active charging session
Example
{
  "unit": "miles_per_hour",
  "value": 25
}

Records

values
array
required
Array of individual charging session records, each representing a completed or ongoing charging event.
Example
{
  "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

values
array
Array of charging timer configurations, each defining either scheduled charging times or departure times.

Charger Phases

unit
string
The number of phases available from the connected charger.
value
integer
The number of phases available from the connected charger.
Example
{
  "unit": "count",
  "value": 3
}

Charging Connector Type

value
string
Identifier for the type of charging connector/inlet equipped on the vehicle.
Example
{
  "value": "J1772"
}

Detailed Charging Status

value
string
String value that provides detailed information about the current state of the charging process.
Example
{
  "value": "CHARGING_AC"
}

Energy Added

unit
string
Cumulative amount of electrical energy delivered to the vehicle during the current or most recent charging session, measured in kilowatt-hours (kWh).
value
number
Cumulative amount of electrical energy delivered to the vehicle during the current or most recent charging session, measured in kilowatt-hours (kWh).
Example
{
  "unit": "kilowatt_hours",
  "value": 25.5
}

Fast Charger Type

value
string
Identifier for the specific DC fast charging standard currently connected to the vehicle. Indicates the protocol being used for high-power charging
Example
{
  "value": "CCS"
}

Is Charging

value
boolean
Boolean indicator that shows whether the electric vehicle is actively receiving power from a charging station or outlet.
Example
{
  "value": true
}

Is Charging Cable Connected

value
boolean
Boolean indicator that shows whether a charging cable is physically connected to the vehicle’s charging port.
Example
{
  "value": true
}

Is Charging Cable Latched

value
boolean
Boolean indicator that shows whether the charging cable is securely locked to the vehicle’s charging port.
Example
{
  "value": true
}

Is Charging Port Flap Open

value
boolean
Boolean indicator that shows whether the vehicle’s charging port access door or flap is currently open.
Example
{
  "value": true
}

Is Fast Charger Present

value
boolean
Boolean indicator that shows whether the vehicle is connected to a DC fast charging station.
Example
{
  "value": true
}

Time To Complete

unit
string
Estimated time remaining until the charging session reaches the activeLimit in minutes.
value
number
Estimated time remaining until the charging session reaches the activeLimit in minutes.
Example
{
  "value": 45
}

Voltage

unit
string
Current voltage level being supplied to the electric vehicle during a charging session, measured in volts.
value
number
Current voltage level being supplied to the electric vehicle during a charging session, measured in volts.
Example
{
  "unit": "volts",
  "value": 240
}

Wattage

unit
string
Current power delivery rate to the electric vehicle during a charging session, measured in watts.
value
number
Current power delivery rate to the electric vehicle during a charging session, measured in watts.
Example
{
  "unit": "watts",
  "value": 250
}