Carbon free energy

Past Range

get
/carbon-free-energy/past-range
When signed in, you can use the interactive API Playground to query the Electricity Maps API directly from this page
Create an accountAlready have an account? Sign in

Get the carbon free energy share for a zone at a given datetime range

Query Parameters

start*string

The start datetime to get the data for.

Formatdate-time
Example"2024-05-19T03:00:00Z"
end*string

The end datetime to get the data for.

Formatdate-time
Example"2024-05-19T08:00:00Z"
temporalGranularity?string

The temporal granularity of the data to get.

Default"hourly"
Example"hourly"

Value in

  • "5_minutes"
  • "15_minutes"
  • "hourly"
  • "daily"
  • "monthly"
  • "quarterly"
  • "yearly"
zone?string

An Electricity Maps zone key.

Example"DK-DK2"
lat?number

Latitude of the location to get the data for.

Example41.877
lon?number

Longitude of the location to get the data for.

Example-88.0703
disableCallerLookup?boolean

If true, the fallback IP-based zone lookup will not be performed.

Defaultfalse
disableEstimations?boolean

If true, the response will exclude estimated data points

Defaultfalse
emissionFactorType?string

The type of emission factor to use.

Default"lifecycle"
Example"lifecycle"

Value in

  • "direct"
  • "lifecycle"
flowTraced?boolean

If true, the response returns flow-traced (consumption-based) values.

Defaulttrue
Exampletrue

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/carbon-free-energy/past-range?start=2024-05-19T03%3A00%3A00Z&end=2024-05-19T08%3A00%3A00Z"
{  "zone": "string",  "data": [    {      "zone": "DK-DK2",      "datetime": "2026-01-01T01:00:00.000Z",      "updatedAt": "2026-01-01T02:00:00.000Z",      "createdAt": "2026-01-01T00:00:00.000Z",      "unit": "%",      "value": 67,      "flowTraced": true,      "isEstimated": false,      "estimationMethod": "string",      "temporalGranularity": "hourly"    }  ],  "temporalGranularity": "hourly",  "aggregationPeriod": "hourly"}

Past GET

Get the carbon free energy share for a zone at a given datetime

History GET

Get the last 24 hours of carbon free energy share for a zone