Vehicle data

Vehicle data

curl --request GET \
  --url https://api.energy-hub.io/v1.0.0/vehicles/{vehicleId} \
  --header 'X-API-KEY: <api-key>'

{
  "isOnline": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
  "staticData": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "vendor": "TESLA",
    "vin": "1XKAD29X0KS502460",
    "model": "Model 3",
    "name": "My Tesla",
    "engineType": "BEV",
    "batteryCapacity": 60.12,
    "vehicleVariant": "Base"
  },
  "lastUpdated": "2023-11-07T05:31:56Z",
  "chargeState": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "stateOfCharge": 72.25,
    "chargingTimeRemaining": 6,
    "chargeLimitMax": 80.25,
    "remoteChargingAllowed": true,
    "estimatedRange": 106,
    "chargingState": "CHARGING",
    "chargeRate": 6.512,
    "chargeLimitMin": 20.25,
    "chargeCurrentMax": 12,
    "scheduledDepartureTime": "2023-11-26T05:05:00Z",
    "isPlugged": true,
    "scheduledChargingStartTime": "2023-11-26T05:00:00Z"
  },
  "odometer": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "odometer": 12228
  },
  "location": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "latitude": 50.770774,
    "longitude": -126.104965
  },
  "climateState": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "isClimateOn": true,
    "isBatteryHeaterOn": true,
    "temperatureCurrent": 18.1,
    "temperatureTarget": 20.1
  }
}

GET

v1.0.0

vehicles

{vehicleId}

Vehicle data

curl --request GET \
  --url https://api.energy-hub.io/v1.0.0/vehicles/{vehicleId} \
  --header 'X-API-KEY: <api-key>'

{
  "isOnline": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
  "staticData": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "vendor": "TESLA",
    "vin": "1XKAD29X0KS502460",
    "model": "Model 3",
    "name": "My Tesla",
    "engineType": "BEV",
    "batteryCapacity": 60.12,
    "vehicleVariant": "Base"
  },
  "lastUpdated": "2023-11-07T05:31:56Z",
  "chargeState": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "stateOfCharge": 72.25,
    "chargingTimeRemaining": 6,
    "chargeLimitMax": 80.25,
    "remoteChargingAllowed": true,
    "estimatedRange": 106,
    "chargingState": "CHARGING",
    "chargeRate": 6.512,
    "chargeLimitMin": 20.25,
    "chargeCurrentMax": 12,
    "scheduledDepartureTime": "2023-11-26T05:05:00Z",
    "isPlugged": true,
    "scheduledChargingStartTime": "2023-11-26T05:00:00Z"
  },
  "odometer": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "odometer": 12228
  },
  "location": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "latitude": 50.770774,
    "longitude": -126.104965
  },
  "climateState": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "isClimateOn": true,
    "isBatteryHeaterOn": true,
    "temperatureCurrent": 18.1,
    "temperatureTarget": 20.1
  }
}

Authorizations

X-API-KEY

string

header

required

API key used for authorization and authentication.

Path Parameters

vehicleId

string<uuid>

required

Vehicle ID

Response

Successful operation

Object of vehicle response.

isOnline

boolean

required

Indicates if the vehicle is reachable trough the vendor system.

Example:

true

string<uuid>

required

The ID of the vehicle.

userId

string

required

The ID of the user.

Example:

"896f9d5a-b618-48a2-98ae-957059bf1bc9"

staticData

object

required

Object of static data of a vehicle.

Show child attributes

staticData.lastUpdated

string<date-time>

required

The timestamp of the last update of the static data.

staticData.vendor

enum<string>

required

The vendor of the vehicle.

Available options:

TESLA,

MERCEDES,

BMW,

MINI,

VW,

AUDI,

SKODA,

VOLVO,

CUPRA

staticData.vin

string

required

The vehicle identification number (VIN).

Example:

"1XKAD29X0KS502460"

staticData.model

string

required

The model of the vehicle.

Example:

"Model 3"

staticData.name

string

The display name of the vehicle.

Example:

"My Tesla"

staticData.engineType

enum<string>

The engine type of the vehicle.

Available options:

BEV,

HEV,

PHEV,

ICEV

Example:

"BEV"

staticData.batteryCapacity

number<double>

The rated battery capacity of the vehicle in kWh.

Example:

60.12

staticData.vehicleVariant

string

The variant of the vehicle.

Example:

"Base"

lastUpdated

string<date-time>

The timestamp of the last update of any field in the vehicle data.

chargeState

object

Object of charge state data of a vehicle.

Show child attributes

chargeState.lastUpdated

string<date-time>

required

The timestamp of the last update of the charge state data.

chargeState.stateOfCharge

number<double>

The state of the charge of the vehicle battery in percent.

Example:

72.25

chargeState.chargingTimeRemaining

integer<int32>

The remaining charging time in minutes.

Example:

6

chargeState.chargeLimitMax

number<double>

The maximum state of charge set by the user for the vehicle in percent.

Example:

80.25

chargeState.remoteChargingAllowed

boolean

Indicates if remote charging controls are allowed. It does not simply mean that the vehicle is unplugged, but rather its a vendor specific restriction for not allowing remote charging at the current time (i.e. location of the vehicle is not correct). Can be NULL for vendors that don't have these kinds of restrictions

chargeState.estimatedRange

integer<int32>

The estimated range based on the current battery level in km.

Example:

106

chargeState.chargingState

enum<string>

The current charging state.

Available options:

UNPLUGGED,

CHARGING,

PREPARING,

FINISHED,

STOPPED,

FAULT

Example:

"CHARGING"

chargeState.chargeRate

number<double>

The rate of the charge while the vehicle is charging in kW.

Example:

6.512

chargeState.chargeLimitMin

number<double>

The minimum state of charge set by the user for the vehicle in percent.

Example:

20.25

chargeState.chargeCurrentMax

integer<int32>

The maximum charging current in amperes.

Example:

12

chargeState.scheduledDepartureTime

string<date-time>

The scheduled departure time set by the user as timestamp.

Example:

"2023-11-26T05:05:00Z"

chargeState.isPlugged

boolean

Indicates if the charger is plugged into the car.

Example:

true

chargeState.scheduledChargingStartTime

string<date-time>

The scheduled charging start time set by the user as timestamp.

Example:

"2023-11-26T05:00:00Z"

odometer

object

Object of odometer data of a vehicle.

Show child attributes

odometer.lastUpdated

string<date-time>

required

The timestamp of the last update of the odometer data.

odometer.odometer

integer<int32>

required

The current odometer of the vehicle in km.

Example:

12228

location

object

Object of location data of a vehicle.

Show child attributes

location.lastUpdated

string<date-time>

required

The timestamp of the last update of the location data.

location.latitude

number<double>

required

The latitude of the location in degrees.

Example:

50.770774

location.longitude

number<double>

required

The longitude of the location in degrees.

Example:

-126.104965

climateState

object

Object of climate state of a vehicle.

Show child attributes

climateState.lastUpdated

string<date-time>

required

The timestamp of the last update of the climate state data.

climateState.isClimateOn

boolean

Indicates if the climate control is on.

Example:

true

climateState.isBatteryHeaterOn

boolean

Indicates if the battery heater is on.

Example:

true

climateState.temperatureCurrent

number<double>

The current temperature inside the vehicle in °C.

Example:

18.1

climateState.temperatureTarget

number<double>

The target temperature set by the user in °C.

Example:

20.1

Link vehicles Vehicle image

⌘I

Introduction

Capabilities

Vehicles

Tariffs

HVACs

Chargers

Home Power Devices

User

Authorizations

Path Parameters

Response