Introduction
Capabilities
Vehicles
- Connect vehicle
- Vehicle
- Vehicle for user
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
Battery for user
Battery data for user
Returns general data of a single battery for the user.
GET
/
v1.0.0
/
users
/
{userId}
/
batteries
/
{batteryId}
curl --request GET \
--url https://api.energy-hub.io/v1.0.0/users/{userId}/batteries/{batteryId} \
--header 'X-API-KEY: <api-key>'
{
"lastUpdated": "2023-11-07T05:31:56Z",
"chargeState": {
"mode": "AUTO",
"chargeRate": 6.512,
"lastUpdated": "2023-11-07T05:31:56Z",
"stateOfCharge": 72.25,
"chargeLimitMin": 20.25,
"chargeLimitMax": 80.25,
"maxChargeRate": 6,
"maxDischargeRate": 6,
"chargingState": "CHARGING"
},
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isOnline": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
"staticData": {
"lastUpdated": "2023-11-07T05:31:56Z",
"vendor": "FRONIUS",
"name": "My device",
"siteName": "My Home",
"model": "Charge",
"batteryCapacity": 12.5
}
}
Authorizations
API key used for authorization and authentication.
Response
200
application/json
Successful operation
Object of battery response.
curl --request GET \
--url https://api.energy-hub.io/v1.0.0/users/{userId}/batteries/{batteryId} \
--header 'X-API-KEY: <api-key>'
{
"lastUpdated": "2023-11-07T05:31:56Z",
"chargeState": {
"mode": "AUTO",
"chargeRate": 6.512,
"lastUpdated": "2023-11-07T05:31:56Z",
"stateOfCharge": 72.25,
"chargeLimitMin": 20.25,
"chargeLimitMax": 80.25,
"maxChargeRate": 6,
"maxDischargeRate": 6,
"chargingState": "CHARGING"
},
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isOnline": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
"staticData": {
"lastUpdated": "2023-11-07T05:31:56Z",
"vendor": "FRONIUS",
"name": "My device",
"siteName": "My Home",
"model": "Charge",
"batteryCapacity": 12.5
}
}
Assistant
Responses are generated using AI and may contain mistakes.