Skip to main content
GET
Solar

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

Solar systems retrieved successfully

id
string

Solar system identifier

siteId
string

Site the array is mapped to

importMpan
string

Import MPAN the array offsets

exportMpan
string

Export MPAN if the site has one

installedCapacityKwp
number

Installed capacity in kWp

commissioningDate
string<date>

Commissioning date if known

portal
string

OEM or installer monitoring portal

acPowerKw
number

Instantaneous AC power in kW

generationKwh
number

Energy generated in the interval in kWh

lifetimeYieldKwh
number

Lifetime or period yield in kWh

selfConsumedKwh
number

Derived self-consumed generation in kWh

exportedKwh
number

Derived or metered exported generation in kWh

status
enum<string>

Inverter / portal status

Available options:
ONLINE,
FAULT,
OFFLINE