Recharge status
Get recharge status
Provides data from several other endpoints to form a list of recharge information for a specific vehicle. For more details see the documentation of each individual endpoint. The recharge information includes:
- Battery Charge Level - The current state of charge of the vehicle's battery, represented as a percentage.
- Electric Range - The estimated distance that the vehicle can travel on its current battery charge, represented in kilometers or miles.
- Estimated Charging Time - The estimated time remaining until the vehicle's battery is fully charged, represented in minutes.
- Charging Connection Status - Indicates whether the vehicle is currently connected to a charger and the type of connection (AC or DC).
- Charging System Status - Indicates the current state of the vehicle's charging system.
- Target Battery Charge Level (Target SoC) - The desired state of charge that the vehicle should aim to achieve during a charging session, represented as a percentage.
- Charging Current Limit (Amp limit) - The maximum current that the vehicle can draw from the charger, represented in amperes.
The TargetBatteryChargeLevel and ChargingCurrentLimit resources are not supported for the EX30 model
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
energy:charging_current_limit
energy:target_battery_level
Headers
| Key | Description |
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.
Query Parameters
| Key | Description |
Key range_unit | Description The unit for the electric range can be selected between metric and imperial. Optional, if not provided, a default will be used for the specific region (EU = metric, US = imperial). |
Response body
The response’s data node contains the vehicle’s latest recharge information.
| Field | Description |
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 has been last retrieved from the vehicle. |
Field electricRange.value | Description The latest retrieved range. |
Field electricRange.unit | Description Either in kilometers or miles (These values are not always exact equal distances, as conversion is done). |
Field electricRange.timestamp | Description Timestamp in ISO-8601 format 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 in ISO-8601 format 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_FAULT, CONNECTION_STATUS_UNSPECIFIED |
Field chargingConnectionStatus.timestamp | Description Timestamp in ISO-8601 format 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_DONE, CHARGING_SYSTEM_FAULT, CHARGING_SYSTEM_SCHEDULED, CHARGING_SYSTEM_UNSPECIFIED |
Field chargingSystemStatus.timestamp | Description Timestamp in ISO-8601 format when the value has been last retrieved from the vehicle. |
Field targetBatteryChargeLevel.value | Description The latest retrieved target battery charge level. |
Field targetBatteryChargeLevel.unit | Description Always percentage. |
Field targetBatteryChargeLevel.timestamp | Description Timestamp in ISO-8601 format when the value has been last retrieved from the vehicle. |
Field chargingCurrentLimit.value | Description The latest retrieved charging current limit. |
Field chargingCurrentLimit.unit | Description Always ampere. |
Field chargingCurrentLimit.timestamp | Description Timestamp in ISO-8601 format when the value has been last retrieved from the vehicle. |
Examples
curl -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>'