Skip to main content
GET
/
v1
/
sites
/
peakDemand
Peak demand for all sites
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/peakDemand \
  --header 'x-api-key: <api-key>'
[
  {
    "siteId": "<string>",
    "peak": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "averageDemand": 123,
    "loadFactor": 123
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.voltview.co.uk/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

VoltView API key

Response

Peak demand data retrieved successfully

​
siteId
string

Site identifier

​
peak
number

Peak power demand in kW

​
timestamp
string<date-time>

Timestamp of peak demand

​
averageDemand
number

Average power demand in kW

​
loadFactor
number

Load factor as a percentage