Sites

Peak demand for all sites

Changed on

Retrieves peak power demand data across all sites

API key: requires the consumption:read scope.

get/v1/sites/peakDemand

Request

  • Base URL
    https://api.voltview.co.uk
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Response

Peak demand data retrieved successfully

siteIdstring

Site identifier

peaknumber

Highest average power in a settlement interval (typically 30 minutes), in kW. This is measured maximum demand, not contracted MIC (kVA).

timestampstring date-time

Start of the interval that set the peak

averageDemandnumber

Mean power over the requested window, in kW

loadFactornumber

Average demand divided by peak, as a percentage. High values mean the site uses its peak steadily; low values mean a short spike.

Changes

    • info

      the endpoint scheme security apiKeyAuth was added to the API

    • info

      the endpoint scheme security sessionJwt was added to the API

    • breaking

      the response property / became optional for the status

    1 more change in this revision