Skip to main content
GET
Get battery information

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Obtain a token from POST /token.

Path Parameters

id
string
required

Battery identifier.

Response

Battery information.

id
string
required

Battery identifier.

manufacturer
string
required

Manufacturer name.

model
string
required

Model name, as reported by the manufacturer.

firmware_version
string | null
required

Firmware version, as reported by the manufacturer. Null if unknown.

nominal_capacity_wh
integer
required

Total capacity stated by the manufacturer, in Wh.

Required range: x >= 0
usable_capacity_wh
integer
required

Capacity that can actually be charged and discharged, in Wh. All stored energy values range from 0 to this value.

Required range: x >= 0
nominal_charge_power_w
integer
required

Rated maximum charging power, in W. A magnitude, always positive.

Required range: x >= 0
nominal_discharge_power_w
integer
required

Rated maximum discharging power, in W. A magnitude, always positive.

Required range: x >= 0
power_measurement_side
enum<string> | null
required

Where battery_power_w is measured: ac on the inverter's AC side, dc at the battery terminals. Null if the manufacturer does not say.

Available options:
ac,
dc,
null