Sign in
On-site assets

Batteries

Read-only battery state of charge and charge/discharge power. A battery is one storage system on a site, mapped to the same import MPAN as the solar it sits with if any. VoltView does not dispatch the battery.

get/v1/assets/batteries

Query parameters

granularity'hour' | 'day' | 'month' | 'year'

Data aggregation granularity

fromstring date-time
Example:2024-01-01T00:00:00.000Z

Start date and time (ISO 8601)

tostring date-time
Example:2024-12-31T23:59:59.999Z

End date and time (ISO 8601)

Response

Batteries retrieved successfully

idstring

Battery identifier

siteIdstring

Site the battery is mapped to

importMpanstring

Import MPAN the battery can offset

usableCapacityKwhnumber

Usable capacity in kWh

coupledSolarIdstring

Linked solar system if present

portalstring

OEM or installer monitoring portal

stateOfChargePctnumber

State of charge as a percentage

energyRemainingKwhnumber

Energy remaining in kWh

chargePowerKwnumber

Charge power in kW, positive into the battery

dischargePowerKwnumber

Discharge power in kW, positive out of the battery

chargeEnergyKwhnumber

Charge energy in the interval in kWh

dischargeEnergyKwhnumber

Discharge energy in the interval in kWh

status'ONLINE' | 'CHARGING' | 'DISCHARGING' | 'IDLE' | 'FAULT'

Battery status from the portal

Changes

Changed in 1 of the 29 revisions of this API.1