Skip to main content
GET
Battery data for user

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.