APIs/Energy APIVersion 1
APIs/Energy APIVersion 1

Electric range

Get electric range

Provides the latest retrieved electric range for a specific vehicle. It indicates the estimated distance that the vehicle can travel on its current battery charge. The electric range is represented in kilometers or miles(These values are not always exact equal distances, as conversion is done).

get

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

Scopes

  • openid

  • energy:electric_range

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.

Query Parameters

KeyDescription

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 estimated distance to empty in kilometers or miles while parked.

FieldDescription

Field

electricRange.value

Description

The latest retrieved range.

Field

electricRange.unit

Description

Either in kilometers or miles.

Field

electricRange.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/electric-range' \
  -H 'accept: application/vnd.volvocars.api.energy.vehicledata.v1+json' \
  -H 'authorization: Bearer <your-access-token>' \
  -H 'vcc-api-key: <your-vcc-api-key>'

/