Emissions

Emissions data for all sites

Changed on

Retrieves carbon emissions data across all sites

API key: requires the emissions:read scope.

get/v1/sites/emissions

Request

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

Query parameters

lookbackstring
Example:1y

Time period to look back (e.g. 1d, 1w, 1m, 1y for day, week, month, year)

Response

Emissions data retrieved successfully

siteIdstring

Site identifier

periodstring

Reporting period

emissionsnumber

Carbon emissions in kg CO2e

emissionsIntensitynumber

Emissions intensity in kg CO2e/kWh

carbonSavingsnumber

Carbon savings compared to baseline in kg CO2e

targetReductionnumber

Target reduction percentage

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