Skip to main content
GET
/
v1.0.0
/
users
/
{userId}
/
batteries
/
{batteryId}
Battery data for user
curl --request GET \
  --url https://api.energy-hub.io/v1.0.0/users/{userId}/batteries/{batteryId} \
  --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",
    "name": "My device",
    "model": "Charge",
    "siteName": "My Home",
    "batteryCapacity": 12.5
  },
  "lastUpdated": "2023-11-07T05:31:56Z",
  "chargeState": {
    "lastUpdated": "2023-11-07T05:31:56Z",
    "chargeRate": 6.512,
    "stateOfCharge": 72.25,
    "chargeLimitMin": 20.25,
    "chargeLimitMax": 80.25,
    "maxChargeRate": 6,
    "maxDischargeRate": 6,
    "chargingState": "CHARGING"
  },
  "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
X-API-KEY
string
header
required

API key used for authorization and authentication.

Path Parameters

​
userId
string
required

User ID

​
batteryId
string<uuid>
required

Battery ID

Response

Successful operation

Object of battery response.

​
isOnline
boolean
required

Indicates if the battery is reachable trough the vendor system.

Example:

true

​
id
string<uuid>
required

The ID of the battery.

​
userId
string
required

The ID of the user.

Example:

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

​
staticData
object
required

Object of static data of a home energy device.

​
lastUpdated
string<date-time>

The timestamp of the last update of any variable of the battery.

​
chargeState
object

Object of charge state data of a battery.

​
locationId
string<uuid>

The location ID of the battery.