Introduction
Capabilities
Vehicles
Tariffs
- Connect tariff
- Tariff
- Tariff for user
HVACs
- Connect HVAC
- HVAC
- HVAC for user
Chargers
- Connect Charger
- Charger
- Charger for User
Home Power Devices
- Connect Home Power Device
- PV-Inverter
- PV-Inverter for user
- Battery
- Battery for user
- Meter
- Meter for user
Vehicle
Refresh vehicle data
Updates vehicle with newest data from vendor system.
GET
/
v1.0.0
/
vehicles
/
{vehicleId}
/
refresh
curl --request GET \
--url https://api.energy-hub.io/v1.0.0/vehicles/{vehicleId}/refresh \
--header 'X-API-KEY: <api-key>'
{
"lastUpdated": "2023-11-07T05:31:56Z",
"chargeState": {
"chargeRate": 6.512,
"lastUpdated": "2023-11-07T05:31:56Z",
"stateOfCharge": 72.25,
"chargingTimeRemaining": 6,
"chargeLimitMin": 20.25,
"chargeLimitMax": 80.25,
"scheduledDepartureTime": "2023-11-26T05:05:00Z",
"scheduledChargingStartTime": "2023-11-26T05:00:00Z",
"estimatedRange": 106,
"chargingState": "CHARGING"
},
"odometer": {
"lastUpdated": "2023-11-07T05:31:56Z",
"odometer": 12228
},
"isOnline": true,
"location": {
"lastUpdated": "2023-11-07T05:31:56Z",
"latitude": 50.770774,
"longitude": -126.104965
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"climateState": {
"lastUpdated": "2023-11-07T05:31:56Z",
"isClimateOn": true,
"isBatteryHeaterOn": true,
"temperatureCurrent": 18.1,
"temperatureTarget": 20.1
},
"userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
"staticData": {
"lastUpdated": "2023-11-07T05:31:56Z",
"vendor": "TESLA",
"name": "My Tesla",
"engineType": "BEV",
"vin": "1XKAD29X0KS502460",
"model": "Model 3",
"batteryCapacity": 60.12,
"vehicleVariant": "Base"
}
}
Authorizations
API key used for authorization and authentication.
Path Parameters
Vehicle ID
Response
200
application/json
Successful operation
Object of vehicle response.
curl --request GET \
--url https://api.energy-hub.io/v1.0.0/vehicles/{vehicleId}/refresh \
--header 'X-API-KEY: <api-key>'
{
"lastUpdated": "2023-11-07T05:31:56Z",
"chargeState": {
"chargeRate": 6.512,
"lastUpdated": "2023-11-07T05:31:56Z",
"stateOfCharge": 72.25,
"chargingTimeRemaining": 6,
"chargeLimitMin": 20.25,
"chargeLimitMax": 80.25,
"scheduledDepartureTime": "2023-11-26T05:05:00Z",
"scheduledChargingStartTime": "2023-11-26T05:00:00Z",
"estimatedRange": 106,
"chargingState": "CHARGING"
},
"odometer": {
"lastUpdated": "2023-11-07T05:31:56Z",
"odometer": 12228
},
"isOnline": true,
"location": {
"lastUpdated": "2023-11-07T05:31:56Z",
"latitude": 50.770774,
"longitude": -126.104965
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"climateState": {
"lastUpdated": "2023-11-07T05:31:56Z",
"isClimateOn": true,
"isBatteryHeaterOn": true,
"temperatureCurrent": 18.1,
"temperatureTarget": 20.1
},
"userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
"staticData": {
"lastUpdated": "2023-11-07T05:31:56Z",
"vendor": "TESLA",
"name": "My Tesla",
"engineType": "BEV",
"vin": "1XKAD29X0KS502460",
"model": "Model 3",
"batteryCapacity": 60.12,
"vehicleVariant": "Base"
}
}
Assistant
Responses are generated using AI and may contain mistakes.