APIs/Energy API
APIs/Energy API

Recharge status

Get latest recharge information

Endpoint used to get the complete list of recharge information.

get

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

Scopes

  • openid

  • energy:recharge_status

  • energy:battery_charge_level

  • energy:electric_range

  • energy:estimated_charging_time

  • energy:charging_connection_status

  • energy:charging_system_status

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 recharge information.

FieldDescription
Field
batteryChargeLevel.value
Description
The latest retrieved battery charge level.
Field
batteryChargeLevel.unit
Description
Always percentage.
Field
batteryChargeLevel.timestamp
Description
Timestamp based on system UTC clock when the value has been last retrieved from the vehicle.
Field
electricRange.value
Description
The latest retrieved range.
Field
electricRange.unit
Description
Always kilometers.
Field
electricRange.timestamp
Description
Timestamp based on system UTC clock when the value has been last retrieved from the vehicle.
Field
estimatedChargingTime.value
Description
The latest retrieved charging time estimate.
Field
estimatedChargingTime.unit
Description
Always minutes.
Field
estimatedChargingTime.timestamp
Description
Timestamp based on system UTC clock when the value has been last retrieved from the vehicle.
Field
chargingConnectionStatus.value
Description
The latest retrieved charging connection status. Possible values: CONNECTION_STATUS_CONNECTED_AC, CONNECTION_STATUS_CONNECTED_DC, CONNECTION_STATUS_DISCONNECTED, CONNECTION_STATUS_UNSPECIFIED.
Field
chargingConnectionStatus.timestamp
Description
Timestamp based on system UTC clock when the value has been last retrieved from the vehicle.
Field
chargingSystemStatus.value
Description
The latest retrieved charging system status. Possible values: CHARGING_SYSTEM_CHARGING, CHARGING_SYSTEM_IDLE, CHARGING_SYSTEM_FAULT, CHARGING_SYSTEM_UNSPECIFIED.
Field
chargingSystemStatus.timestamp
Description
Timestamp based on system UTC clock when the value has been last retrieved from the vehicle.

Examples

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

Recharge status/Get latest recharge information