APIs/Energy APIVersion 1
APIs/Energy APIVersion 1

Battery charge level

Get battery charge level

Provides the latest retrieved battery charge level, also known as the state of charge (SoC), for a specific vehicle. The battery charge level is represented as a percentage, with 100% indicating a fully charged battery, and 0% indicating a completely depleted battery.

get

https://api.volvocars.com/energy/v1/vehicles/{vin}/recharge-status/battery-charge-level

Scopes

  • openid

  • energy:battery_charge_level

Headers

KeyDescription

Key

accept

Description

The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.energy.vehicledata.v1+json

Key

authorization

Description

The access token issued by Volvo ID identity system.

Key

vcc-api-key

Description

Your application’s VCC API Key.

All these header values are mandatory. They must exist in every request.

Response body

The response’s data node lists the vehicle’s latest battery charge level in percentage.

FieldDescription

Field

batteryChargeLevel.value

Description

The latest retrieved battery charge level.

Field

batteryChargeLevel.unit

Description

Always percentage.

Field

batteryChargeLevel.timestamp

Description

Timestamp in ISO-8601 format when the value was last retrieved from the vehicle.

Examples

curl -X GET 'https://api.volvocars.com/energy/v1/vehicles/{vin}/recharge-status/battery-charge-level' \
  -H 'accept: application/vnd.volvocars.api.energy.vehicledata.v1+json' \
  -H 'authorization: Bearer <your-access-token>' \
  -H 'vcc-api-key: <your-vcc-api-key>'

/