Charge Signals

Amperage

GET /vehicles/{vehicleId}/signals/charge-amperage

Current amperage flowing to the electric vehicle during a charging session, measured in amps.

body · object

Show body properties

unit · string

value · number

Example

{
  "value": 33,
  "unit": "ampere"
}

AmperageMax

GET /vehicles/{vehicleId}/signals/charge-amperagemax

The maximum available amps available to charge.

body · object

Show body properties

unit · string

value · number

Example

{
  "value": 48,
  "unit": "ampere"
}

AmperageRequested

GET /vehicles/{vehicleId}/signals/charge-amperagerequested

The requested amps to charge the vehicle.

body · object

Show body properties

unit · string

value · number

Example

{
  "value": 48,
  "unit": "ampere"
}

ChargeLimits

GET /vehicles/{vehicleId}/signals/charge-chargelimits

Object containing the default (global) charge limit configuration and configurations based on location, and charging type (AC or DC)

body · object

Show body properties

values · array

Show Array item properties

type · string

Possible values: GLOBAL, LOCATION, CHARGING_TYPE

limit · number

condition · object

Show condition properties

name · string

address · string

latitude · number

longitude · number

chargingType · string

activeLimit · number

Maximum state of charge (SoC) limit currently configured, expressed as a percentage.

unit · string

Example

{
  "activeLimit": 80,
  "values": [
    {
      "type": "GLOBAL",
      "limit": 80
    },
    {
      "type": "LOCATION",
      "condition": {
        "name": "Home",
        "address": "123 2nd street",
        "latitude": 90,
        "longitude": 90
      },
      "limit": 72
    },
    {
      "type": "CHARGING_TYPE",
      "condition": {
        "chargingType": "AC"
      },
      "limit": 52
    }
  ],
  "unit": "percent"
}

ChargePortStatusColor

GET /vehicles/{vehicleId}/signals/charge-chargeportstatuscolor

Current status indicator color displayed on or around the vehicle’s charging port.

body · object

Show body properties

value · string

Example

{
  "value": "Green"
}

ChargeRate

GET /vehicles/{vehicleId}/signals/charge-chargerate

Current rate at which range is being added to the vehicle during an active charging session

body · object

Show body properties

unit · string

value · number

Example

{
  "value": 48,
  "unit": "km/h"
}

ChargeRecords

GET /vehicles/{vehicleId}/signals/charge-chargerecords

Collection of historical charging session data stored by the vehicle.

body · object

Show body properties

values · array · required

Show Array item properties

id · string

Unique OEM identifier assigned to the specific charging session.

cost · object

Show cost properties

currency · string

Three-letter currency code representing the monetary unit used for the charging session transaction.

otherAmount · number

Monetary value representing all non-energy related charges incurred during the charging session.

energyAmount · number

Monetary value representing the cost specifically for the electrical energy consumed during the charging session.

endTime · string

Timestamp marking when a charging session was completed or terminated.

location · object

Show location properties

name · string

Descriptive text identifier for the facility or establishment where the charging session occurred.

address · string

Structured or formatted text representing the physical street address where the charging session took place.

latitude · number

Numerical value representing the north-south position of the charging location on Earth’s surface.

longitude · number

Numerical value representing the east-west position of the charging location on Earth’s surface.

startTime · string

Timestamp marking when a charging session was initiated.

energyAdded · number

Total amount of electrical energy drawn from the charging source during the charging session, measured in kilowatt-hours (kWh).

chargingType · string

Type of charging used during the recorded charging session.

isPublicCharger · boolean

Boolean indicator that shows whether the charging session occurred at a public charging station rather than at a private or home charging location.

endStateOfCharge · number

Percentage value indicating the vehicle’s battery state of charge (SoC) at the conclusion of a charging session.

startStateOfCharge · number

Percentage value indicating the vehicle’s battery state of charge (SoC) at the beginning of a charging session.

Example

{
  "values": [
    {
      "startTime": "2023-10-15T19:30:00.000Z",
      "endTime": "2023-10-16T06:45:00.000Z",
      "startStateOfCharge": 25,
      "endStateOfCharge": 90,
      "energyAdded": 65.2,
      "isPublicCharger": false,
      "chargingType": "DC",
      "cost": {
        "currency": "GBP",
        "energyAmount": 12.56,
        "otherAmount": 0
      },
      "location": {
        "latitude": 51.5014,
        "longitude": -0.1419,
        "name": "Home",
        "address": "123 Park Lane, London SW1A 1AA"
      },
      "id": "CHG-20231015-A39B"
    }
  ]
}

ChargerPhases

GET /vehicles/{vehicleId}/signals/charge-chargerphases

The number of phases available from the connected charger.

body · object

Show body properties

unit · string

value · integer

Example

{
  "value": 3
}

ChargeTimers

GET /vehicles/{vehicleId}/signals/charge-chargetimers

Object containing the default (GLOBAL) charge timer configuration and configurations based on location, and charing type (AC or DC)

body · object

Show body properties

values · array

Show Array item properties

type · string

Possible values: GLOBAL, LOCATION, CHARGING_TYPE

condition · object

Show condition properties

name · string

address · string

latitude · number

longitude · number

chargingType · string

schedules · array

Show Array item properties

end · string

days · array

start · string

departureTimers · array

Show Array item properties

days · array

time · string

isOEMOptimizationEnabled · boolean

Example

{
  "values": [
    {
      "type": "GLOBAL",
      "isOEMOptimizationEnabled": true,
      "schedules": [
        {
          "days": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY"
          ],
          "start": "23:00:00",
          "end": "07:00:00"
        }
      ],
      "departureTimers": [
        {
          "days": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY"
          ],
          "time": "08:30:00"
        }
      ]
    },
    {
      "type": "LOCATION",
      "condition": {
        "latitude": 51.5014,
        "longitude": -0.1419,
        "name": "Home",
        "address": "123 Main St, London"
      },
      "isOEMOptimizationEnabled": true,
      "schedules": [
        {
          "days": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY"
          ],
          "start": "22:00:00",
          "end": "06:00:00"
        }
      ],
      "departureTimers": [
        {
          "days": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY"
          ],
          "time": "08:00:00"
        }
      ]
    },
    {
      "type": "CHARGING_TYPE",
      "condition": {
        "chargingType": "DC"
      },
      "isOEMOptimizationEnabled": true,
      "schedules": [
        {
          "days": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY"
          ],
          "start": "22:00:00",
          "end": "06:00:00"
        }
      ],
      "departureTimers": [
        {
          "days": [
            "MONDAY",
            "TUESDAY"
          ],
          "time": "08:00:00"
        }
      ]
    }
  ]
}

ChargingConnectorType

GET /vehicles/{vehicleId}/signals/charge-chargingconnectortype

Identifier for the type of charging connector/inlet equipped on the vehicle.

body · object

Show body properties

value · string

Example

{
  "value": "J1772"
}

DetailedChargingStatus

GET /vehicles/{vehicleId}/signals/charge-detailedchargingstatus

String value that provides detailed information about the current state of the charging process.

body · object

Show body properties

value · string

Example

{
  "value": "CHARGING"
}

EnergyAdded

GET /vehicles/{vehicleId}/signals/charge-energyadded

Cumulative amount of electrical energy delivered to the vehicle during the current or most recent charging session, measured in kilowatt-hours (kWh).

body · object

Show body properties

unit · string

value · number

Example

{
  "value": 35.6,
  "unit": "kWh"
}

FastChargerType

GET /vehicles/{vehicleId}/signals/charge-fastchargertype

Identifier for the specific DC fast charging standard currently connected to the vehicle. Indicates the protocol being used for high-power charging

body · object

Show body properties

value · string

Example

{
  "value": "CCS"
}

IsCharging

GET /vehicles/{vehicleId}/signals/charge-ischarging

Boolean indicator that shows whether the electric vehicle is actively receiving power from a charging station or outlet.

body · object

Show body properties

value · boolean

Example

{
  "value": true
}

IsChargingCableConnected

GET /vehicles/{vehicleId}/signals/charge-ischargingcableconnected

Boolean indicator that shows whether a charging cable is physically connected to the vehicle’s charging port.

body · object

Show body properties

value · boolean

Example

{
  "value": true
}

IsChargingCableLatched

GET /vehicles/{vehicleId}/signals/charge-ischargingcablelatched

Boolean indicator that shows whether the charging cable is securely locked to the vehicle’s charging port.

body · object

Show body properties

value · boolean

Example

{
  "value": true
}

IsChargingPortFlapOpen

GET /vehicles/{vehicleId}/signals/charge-ischargingportflapopen

Boolean indicator that shows whether the vehicle’s charging port access door or flap is currently open.

body · object

Show body properties

value · boolean

Example

{
  "value": true
}

IsFastChargerPresent

GET /vehicles/{vehicleId}/signals/charge-isfastchargerpresent

Boolean indicator that shows whether the vehicle is connected to a DC fast charging station.

body · object

Show body properties

value · boolean

Example

{
  "value": false
}

TimeToComplete

GET /vehicles/{vehicleId}/signals/charge-timetocomplete

Estimated time remaining until the charging session reaches the activeLimit in minutes.

body · object

Show body properties

unit · string

value · number

Example

{
  "value": 100,
  "unit": "min"
}

Voltage

GET /vehicles/{vehicleId}/signals/charge-voltage

Current voltage level being supplied to the electric vehicle during a charging session, measured in volts.

body · object

Show body properties

unit · string

value · number

Example

{
  "value": 240,
  "unit": "volts"
}

Wattage

GET /vehicles/{vehicleId}/signals/charge-wattage

Current power delivery rate to the electric vehicle during a charging session, measured in watts.

body · object

Show body properties

unit · string

value · number

Example

{
  "value": 10.7,
  "unit": "watts"
}