Peak demand for a specific site

GET

sites

{siteId}

peakDemand

curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/{siteId}/peakDemand \
  --header 'Authorization: Bearer <token>'

{
  "siteId": "<string>",
  "peak": 123,
  "timestamp": "2023-11-07T05:31:56Z",
  "averageDemand": 123,
  "loadFactor": 123
}

Authorization

string

header

required

JWT token obtained from /v1/requestToken endpoint

siteId

string

required

Site identifier

200

application/json

Peak demand data retrieved successfully

The response is of type object.

curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/{siteId}/peakDemand \
  --header 'Authorization: Bearer <token>'

{
  "siteId": "<string>",
  "peak": 123,
  "timestamp": "2023-11-07T05:31:56Z",
  "averageDemand": 123,
  "loadFactor": 123
}