Skip to main content
GET
/
v1.0.0
/
users
/
{userId}
/
vehicles
/
{vehicleId}
Vehicle data for user
curl --request GET \
  --url https://api.energy-hub.io/v1.0.0/users/{userId}/vehicles/{vehicleId} \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.energy-hub.io/v1.0.0/users/{userId}/vehicles/{vehicleId}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.energy-hub.io/v1.0.0/users/{userId}/vehicles/{vehicleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.energy-hub.io/v1.0.0/users/{userId}/vehicles/{vehicleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.energy-hub.io/v1.0.0/users/{userId}/vehicles/{vehicleId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.energy-hub.io/v1.0.0/users/{userId}/vehicles/{vehicleId}")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.energy-hub.io/v1.0.0/users/{userId}/vehicles/{vehicleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "isOnline": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
  "staticData": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "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
  }
}
{
"errorCode": "UNAUTHORIZED",
"id": "cae58230-364d-45ca-b67d-08a57653c59f",
"message": "Unauthorized"
}
{
"errorCode": "VEHICLE_NOT_FOUND",
"id": "cae58230-364d-45ca-b67d-08a57653c59f",
"message": "[VEHICLE] Requested Vehicle not found"
}

Authorizations

X-API-KEY
string
header
required

API key used for authorization and authentication.

Path Parameters

userId
string
required

User ID

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

id
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.

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.

odometer
object

Object of odometer data of a vehicle.

location
object

Object of location data of a vehicle.

climateState
object

Object of climate state of a vehicle.