Skip to main content
GET
/
v1
/
sites
/
emissions
Emissions data for all sites
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites/emissions \
  --header 'Authorization: Bearer <token>'
[
  {
    "siteId": "<string>",
    "period": "<string>",
    "emissions": 123,
    "emissionsIntensity": 123,
    "emissionsBySource": {
      "electricity": 123,
      "gas": 123,
      "other": 123
    },
    "historicalData": [
      {
        "period": "<string>",
        "emissions": 123
      }
    ],
    "carbonSavings": 123,
    "targetReduction": 123
  }
]

Authorizations

Authorization
string
header
required

Supabase Auth JWT access token obtained after signing in via magic link or OTP

Query Parameters

lookback
string

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

Pattern: ^\d+[dwmy]$
Example:

"1y"

Response

Emissions data retrieved successfully

siteId
string

Site identifier

period
string

Reporting period

emissions
number

Carbon emissions in kg CO2e

emissionsIntensity
number

Emissions intensity in kg CO2e/kWh

emissionsBySource
object

Breakdown of emissions by source

historicalData
object[]

Historical emissions data for comparison

carbonSavings
number

Carbon savings compared to baseline in kg CO2e

targetReduction
number

Target reduction percentage