Skip to main content
GET
Batteries

Authorizations

x-api-key
string
header
required

VoltView API key

Query Parameters

granularity
enum<string>

Data aggregation granularity

Available options:
hour,
day,
month,
year
from
string<date-time>

Start date and time (ISO 8601)

Example:

"2024-01-01T00:00:00.000Z"

to
string<date-time>

End date and time (ISO 8601)

Example:

"2024-12-31T23:59:59.999Z"

Response

Batteries retrieved successfully

id
string

Battery identifier

siteId
string

Site the battery is mapped to

importMpan
string

Import MPAN the battery can offset

usableCapacityKwh
number

Usable capacity in kWh

coupledSolarId
string

Linked solar system if present

portal
string

OEM or installer monitoring portal

stateOfChargePct
number

State of charge as a percentage

energyRemainingKwh
number

Energy remaining in kWh

chargePowerKw
number

Charge power in kW, positive into the battery

dischargePowerKw
number

Discharge power in kW, positive out of the battery

chargeEnergyKwh
number

Charge energy in the interval in kWh

dischargeEnergyKwh
number

Discharge energy in the interval in kWh

status
enum<string>

Battery status from the portal

Available options:
ONLINE,
CHARGING,
DISCHARGING,
IDLE,
FAULT