Sign in
Sites

Add a contractual instrument to an active site

A PPA, green tariff, unbundled certificates or the default grid over a period, for the whole site or one of its supply_point matchers. Requires org.write_data.

post/sites/{siteId}/energy-instruments

Path parameters

siteIdstring required

Request body

certificateScheme'' | 'GO' | 'REGO' | 'REC' | 'I-REC' | 'other' required
certifiedKwhnumber double nullable required

Low-carbon kWh the instrument certifies; always null for default_grid.

evidenceUrlstring required
lowCarbonSharenumber double nullable required

The supplier's fuel mix, as the low-carbon share of its generation.

notestring required
periodEndstring date required

The day after the last day covered.

periodStartstring date required
supplierKgCo2ePerKwhnumber double nullable required

The supplier-specific emission rate.

supplierNamestring required
supplyPointstring required

Normalized value of one of the site's supply_point matchers; empty for the whole site.

type'ppa' | 'green_tariff' | 'unbundled_eac' | 'default_grid' required

Response

Created instrument

Changes

Changed in 1 of the 7 revisions of this API.1