API Reference

• GET

  /v3/carbon-intensity/past

  Past Carbon Intensity

  This endpoint retrieves a past carbon intensity (in gCO2eq/kWh) of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Read more details about how we calculate the carbon intensity on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • emissionFactorTypestringoptional

    Select the emission-factor-type - can be "lifecycle" (LCA) or "direct" (operational)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity/past-range

  Past Range Carbon Intensity

  This endpoint retrieves a past carbon intensity (in gCO2eq/kWh) of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity. If you need more data, you can loop over time ranges. Ex: first recover data between the 2025-01-01 to 2025-01-10, then between the 2025-01-10 and 2025-01-20 etc etc.

  Read more details about how we calculate the carbon intensity on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • emissionFactorTypestringoptional

    Select the emission-factor-type - can be "lifecycle" (LCA) or "direct" (operational)

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity/history

  Recent Carbon Intensity (last 24 hours)

  This endpoint retrieves the last 24 hours of carbon intensity (in gCO2eq/kWh) of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Read more details about how we calculate the carbon intensity on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • latstringoptional

    Latitude, if querying with a geolocation

  • lonstringoptional

    Longitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • emissionFactorTypestringoptional

    Select the emission-factor-type - can be "lifecycle" (LCA) or "direct" (operational)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity/latest

  Latest Carbon Intensity

  This endpoint retrieves the last known carbon intensity (in gCO2eq/kWh) of electricity consumed in an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Read more details about how we calculate the carbon intensity on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  • emissionFactorTypestringoptional

    Select the emission-factor-type - can be "lifecycle" (LCA) or "direct" (operational)

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity/forecast

  Forecasted Carbon Intensity

  This endpoint retrieves the forecasted carbon intensity (in gCO2eq/kWh) of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  By default, this endpoint returns 25 hours of forecasts. The forecasts span from horizon 0, which is the start of the current hour, to horizon 24.

  Example: If the date and time is currently 2024-03-02 13:12:39 GMT, then the forecasts will cover the range from 2024-03-02 13:00:00 GMT to 2024-03-03 13:00:00 GMT.

  You can supply an optional horizonHours query parameter to receive forecasts for a different time horizon (availability depends on your plan). If you specify 24 for the horizonHours parameter, you will receive 25 hours of forecasts. Accepted values are 6, 24, 48 and 72 hours.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity-fossil-only/past

  Past Carbon Intensity Fossil Fuels Only

  This endpoint retrieves a past carbon intensity (in gCO2eq/kWh) of an area, when only considering fossil fuel based sources.

  The carbon intensity from fossil sources only can be used as a proxy for the carbon intensity of the residual mix.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Read more details about how we calculate the carbon intensity on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • emissionFactorTypestringoptional

    Select the emission-factor-type - can be "lifecycle" (LCA) or "direct" (operational)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity-fossil-only/past-range

  Past Range Carbon Intensity Fossil Fuels Only

  This endpoint retrieves a past carbon intensity (in gCO2eq/kWh) of an area when only considering fossil fuel based sources.

  The carbon intensity from fossil sources only can be used as a proxy for the carbon intensity of the residual mix.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity. If you need more data, you can loop over time ranges. Ex: first recover data between the 2025-01-01 to 2025-01-10, then between the 2025-01-10 and 2025-01-20 etc etc.

  Read more details about how we calculate the carbon intensity on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • emissionFactorTypestringoptional

    Select the emission-factor-type - can be "lifecycle" (LCA) or "direct" (operational)

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity-fossil-only/history

  Recent Carbon Intensity Fossil Fuels Only (last 24 hours)

  This endpoint retrieves the last 24 hours of carbon intensity (in gCO2eq/kWh) of an area when only considering fossil fuel based sources.

  The carbon intensity from fossil sources only can be used as a proxy for the carbon intensity of the residual mix.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Read more details about how we calculate the carbon intensity on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • latstringoptional

    Latitude, if querying with a geolocation

  • lonstringoptional

    Longitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • emissionFactorTypestringoptional

    Select the emission-factor-type - can be "lifecycle" (LCA) or "direct" (operational)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity-fossil-only/latest

  Latest Carbon Intensity Fossil Fuels Only

  This endpoint retrieves the last known flow-traced carbon intensity (in gCO2eq/kWh) of electricity, when only considering fossil fuel based sources, in an area.

  The carbon intensity from fossil sources only can be used as a proxy for the carbon intensity of the residual mix.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Read more details about how we calculate the carbon intensity on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  • emissionFactorTypestringoptional

    Select the emission-factor-type - can be "lifecycle" (LCA) or "direct" (operational)

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity-fossil-only/forecast

  Forecasted Carbon Intensity Fossil Fuels Only

  This endpoint retrieves the forecasted carbon intensity (in gCO2eq/kWh) of an area, when only considering fossil fuel based sources.

  The carbon intensity from fossil sources only can be used as a proxy for the carbon intensity of the residual mix.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  By default, this endpoint returns 25 hours of forecasts. The forecasts span from horizon 0, which is the start of the current hour, to horizon 24.

  Example: If the date and time is currently 2024-03-02 13:12:39 GMT, then the forecasts will cover the range from 2024-03-02 13:00:00 GMT to 2024-03-03 13:00:00 GMT.

  You can supply an optional horizonHours query parameter to receive forecasts for a different time horizon (availability depends on your plan). If you specify 24 for the horizonHours parameter, you will receive 25 hours of forecasts. Accepted values are 6, 24, 48 and 72 hours.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/renewable-energy/past

  Past Renewable Energy Percentage

  This endpoint retrieves a past renewable energy percentage (in %) of an area.

  It can either be queried by zone identifier or by geolocation.

  The temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/renewable-energy/past-range

  Past Range Renewable Energy Percentage

  This endpoint retrieves a past renewable energy percentage (in %) of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity. If you need more data, you can loop over time ranges. Ex: first recover data between the 2025-01-01 to 2025-01-10, then between the 2025-01-10 and 2025-01-20 etc etc.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/renewable-energy/history

  Recent Renewable Energy Percentage (last 24 hours)

  This endpoint retrieves the last 24 hours of renewable energy percentage (in %) of an area.

  It can either be queried by zone identifier or by geolocation.

  The temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • latstringoptional

    Latitude, if querying with a geolocation

  • lonstringoptional

    Longitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/renewable-energy/latest

  Latest Renewable Energy Percentage

  This endpoint retrieves the last known renewable energy percentage (in %) of electricity consumed in an area. Read more details about how we calculate this number on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/renewable-energy/forecast

  Forecasted Renewable Energy Percentage

  This endpoint retrieves the forecasted renewable energy percentage (in %) of an area.

  It can either be queried by zone identifier or by geolocation.

  By default, this endpoint returns 25 hours of forecasts. The forecasts span from horizon 0, which is the start of the current hour, to horizon 24.

  Example: If the date and time is currently 2024-03-02 13:12:39 GMT, then the forecasts will cover the range from 2024-03-02 13:00:00 GMT to 2024-03-03 13:00:00 GMT.

  You can supply an optional horizonHours query parameter to receive forecasts for a different time horizon (availability depends on your plan). If you specify 24 for the horizonHours parameter, you will receive 25 hours of forecasts. Accepted values are 6, 24, 48 and 72 hours.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-free-energy/past

  Past Carbon-Free Energy Percentage

  This endpoint retrieves a past carbon-free energy percentage (in %) of an area.

  It can either be queried by zone identifier or by geolocation.

  The temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-free-energy/past-range

  Past Range Carbon-Free Energy Percentage

  This endpoint retrieves a past carbon-free energy percentage (in %) of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity. If you need more data, you can loop over time ranges. Ex: first recover data between the 2025-01-01 to 2025-01-10, then between the 2025-01-10 and 2025-01-20 etc etc.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-free-energy/history

  Recent Carbon-Free Energy Percentage (last 24 hours)

  This endpoint retrieves the last 24 hours of carbon-free energy percentage (in %) of an area.

  It can either be queried by zone identifier or by geolocation.

  The temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • latstringoptional

    Latitude, if querying with a geolocation

  • lonstringoptional

    Longitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-free-energy/latest

  Latest Carbon-Free Energy Percentage

  This endpoint retrieves the last known carbon-free energy percentage (in %) of electricity consumed in an area. Read more details about how we calculate this number on the Methodology page.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-free-energy/forecast

  Forecasted Carbon-Free Energy Percentage

  This endpoint retrieves the forecasted carbon-free energy percentage (in %) of an area.

  It can either be queried by zone identifier or by geolocation.

  By default, this endpoint returns 25 hours of forecasts. The forecasts span from horizon 0, which is the start of the current hour, to horizon 24.

  Example: If the date and time is currently 2024-03-02 13:12:39 GMT, then the forecasts will cover the range from 2024-03-02 13:00:00 GMT to 2024-03-03 13:00:00 GMT.

  You can supply an optional horizonHours query parameter to receive forecasts for a different time horizon (availability depends on your plan). If you specify 24 for the horizonHours parameter, you will receive 25 hours of forecasts. Accepted values are 6, 24, 48 and 72 hours.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/<sourceType>/past

  Past Electricity Source

  This endpoint retrieves past electricity generation data for a specific source type in a zone, showing the generation from that particular energy source for a single datetime.

  Source Type: Replace <sourceType> in the URL with the desired energy source (e.g., solar, wind, hydro, nuclear, gas, coal, oil, biomass, geothermal, hydro-discharge, battery-discharge).

  Data Type: Returns flow-traced data by default (what was actually consumed in the zone from this source), or non-flow-traced if flowTraced=false.

  Datetimes: Specify a datetime parameter in ISO format to get a single datetime or use the past-range endpoint to get a range of datetimes.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/<sourceType>/past-range

  Past Range Electricity Source

  This endpoint retrieves past electricity generation data for a specific source type in a zone, showing the generation from that particular energy source for a range of datetimes.

  Source Type: Replace <sourceType> in the URL with the desired energy source (e.g., solar, wind, hydro, nuclear, gas, coal, oil, biomass, geothermal, hydro-discharge, battery-discharge).

  Data Type: Returns flow-traced data by default (what was actually consumed in the zone from this source), or non-flow-traced if flowTraced=false.

  Range: Specify a start and end parameter in ISO format to set the range of datetimes to retrieve.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity. If you need more data, you can loop over time ranges. Ex: first recover data between the 2025-01-01 to 2025-01-10, then between the 2025-01-10 and 2025-01-20 etc etc.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/<sourceType>/history

  Recent Electricity Source

  This endpoint retrieves the last 24 hours of electricity generation data for a specific source type in a zone, showing real-time generation from that particular energy source.

  Source Type: Replace <sourceType> in the URL with the desired energy source (e.g., solar, wind, hydro, nuclear, gas, coal, oil, biomass, geothermal, hydro-discharge, battery-discharge).

  Data Type: Returns flow-traced data by default (what is actually consumed in the zone from this source), or non-flow-traced if flowTraced=false.

  Example: /v3/electricity-source/solar/history?zone=DE returns the latest 24 hours of solar generation data for Germany.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/<sourceType>/latest

  Latest Electricity Source

  This endpoint retrieves the most recent electricity generation data for a specific source type in a zone, showing real-time generation from that particular energy source.

  Source Type: Replace <sourceType> in the URL with the desired energy source (e.g., solar, wind, hydro, nuclear, gas, coal, oil, biomass, geothermal, hydro-discharge, battery-discharge).

  Data Type: Returns flow-traced data by default (what is actually consumed in the zone from this source), or non-flow-traced if flowTraced=false.

  Example: /v3/electricity-source/solar/latest?zone=DE returns the latest solar generation data for Germany.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/<sourceType>/forecast

  Forecasted Electricity Source

  This endpoint returns a time series of forecast electricity generation data for a specific source type in a zone, showing predicted future generation from that particular energy source.

  Source Type: Replace <sourceType> in the URL with the desired energy source (e.g., solar, wind, hydro, nuclear, gas, coal, oil, biomass, geothermal, hydro-discharge, battery-discharge).

  Data Type: Returns flow-traced data by default (what is actually consumed in the zone from this source), or non-flow-traced if flowTraced=false.

  Horizons: Depending on token permissions this can be 24, 48 or 72 hours ahead of real-time.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/past

  Past Electricity Mix

  This endpoint retrieves past electricity mix data for a zone, showing the mix of electricity by source for a single datetime.

  Data Type: Returns flow-traced electricity mix by default (what is actually consumed in the zone), or non-flow-traced electricity mix if flowTraced=false.

  Mix Values: Includes all sources—nuclear, geothermal, biomass, coal, wind, solar, hydro, gas, oil, and unknown—as well as storage discharges from hydro and batteries.

  Datetimes: Specify a datetime parameter in ISO format to get a single datetime or use the past-range endpoint to get a range of datetimes.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  • datetimedatetime (ISO)

    Date in ISO format

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/past-range

  Past Range Electricity Mix

  This endpoint retrieves past electricity mix data for a zone, showing the mix of electricity for a range of datetimes.

  Data Type: Returns flow-traced electricity mix by default (what is actually consumed in the zone), or non-flow-traced electricity mix if flowTraced=false.

  Mix Values: Includes all sources—nuclear, geothermal, biomass, coal, wind, solar, hydro, gas, oil, and unknown—as well as storage discharges from hydro and batteries.

  Range: Specify a start and end parameter in ISO format to set the range of datetimes to retrieve.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/history

  Recent Electricity Mix (last 24 hours)

  This endpoint retrieves the last 24 hours of electricity mix data for a zone, showing the mix of electricity by source in real-time.

  Data Type: Returns flow-traced electricity mix by default (what is actually consumed in the zone), or non-flow-traced electricity mix if flowTraced=false.

  Mix Values: Includes all sources—nuclear, geothermal, biomass, coal, wind, solar, hydro, gas, oil, and unknown—as well as storage discharges from hydro and batteries.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/latest

  Latest Electricity Mix

  This endpoint retrieves the most recent electricity mix data for a zone, showing the mix of electricity by source in real-time.

  Data Type: Returns flow-traced electricity mix by default (what is actually consumed in the zone), or non-flow-traced electricity mix if flowTraced=false.

  Mix Values: Includes all sources—nuclear, geothermal, biomass, coal, wind, solar, hydro, gas, oil, and unknown—as well as storage discharges from hydro and batteries.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-mix/forecast

  Forecasted Electricity Mix

  This endpoint returns a time series of forecast electricity mix data for a zone, showing the mix of electricity by source in real-time.

  Data Type: Returns flow-traced electricity mix by default (what is actually consumed in the zone), or non-flow-traced electricity mix if flowTraced=false.

  Mix Values: Includes all sources—nuclear, geothermal, biomass, coal, wind, solar, hydro, gas, oil, and unknown—as well as storage discharges from hydro and batteries.

  Horizons: Depending on token permissions this can be 24, 48 or 72 hours ahead of real-time.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • flowTracedbooleanoptional

    Traces back the electricity mix to include import and export flows. Defaults to true

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-flows/past

  Past Electricity Flows

  This endpoint retrieves past electricity flows for a zone, showing the imports and exports of electricity between regions.

  Datetime: Specify a datetime parameter in ISO format for a single datetime or use the past-range endpoint to get a range of datetimes.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-flows/past-range

  Past Range Electricity Flows

  This endpoint retrieves a range of datetimes with electricity flows for a zone, showing the imports and exports of electricity between regions.

  Range: Specify a start and end parameter in ISO format to set the range of datetimes to retrieve.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-flows/history

  Recent Electricity Flows (last 24 hours)

  This endpoint retrieves the last 24 hours of electricity flows for a zone, showing the imports and exports of electricity between regions.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-flows/latest

  Latest Electricity Flows

  This endpoint retrieves the most recent electricity flows for a zone, showing the imports and exports of electricity between regions.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/electricity-flows/forecast

  Forecasted Electricity Flows

  This endpoint returns a time series of forecasted electricity flow data for a zone, showing the imports and exports of electricity between regions.

  Horizons: Depending on token permissions this can be 24, 48 or 72 hours ahead of real-time.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/price-day-ahead/past

  Past Day-ahead Price

  This endpoint retrieves a past published day-ahead price (in local currency, ex: EUR/MWh).

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/price-day-ahead/past-range

  Past Range Day-ahead Price

  This endpoint retrieves past published day-ahead prices within a given date range (in local currency, ex: EUR/MWh).

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity. If you need more data, you can loop over time ranges. Ex: first recover data between the 2025-01-01 to 2025-01-10, then between the 2025-01-10 and 2025-01-20 etc etc.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/price-day-ahead/history

  Recent Day-ahead Price (last 24 hours)

  This endpoint retrieves past published day-ahead prices for the last 24 hours (in local currency, ex: EUR/MWh).

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/price-day-ahead/latest

  Latest Day-ahead Price

  This endpoint retrieves the last known published day-ahead price (in local currency, ex: EUR/MWh).

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/price-day-ahead/forecast

  Forecasted Day-ahead Price

  This endpoint exposes both the future actual and, when not available, modeled market day-ahead prices (in local currency, ex: EUR/MWh) of an area.

  When actual day-ahead market prices are published for the horizon requested, actual prices are returned by the endpoint. When prices are not yet published, prices forecasted by Electricity Maps' models are returned. The source is indicated for every datapoint in the response field 'source'.

  It can either be queried by zone identifier or by geolocation.

  By default, this endpoint returns 25 hours of forecasts. The forecasts span from horizon 0, which is the start of the current hour, to horizon 24.

  Example: If the date and time is currently 2024-03-02 13:12:39 GMT, then the forecasts will cover the range from 2024-03-02 13:00:00 GMT to 2024-03-03 13:00:00 GMT.

  You can supply an optional horizonHours query parameter to receive forecasts for a different time horizon (availability depends on your plan). If you specify 24 for the horizonHours parameter, you will receive 25 hours of forecasts. Accepted values are 6, 24, 48 and 72 hours.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/price-day-ahead/actual

  Actual Day-ahead Price

  This endpoint exposes actual day-ahead prices (in local currency, ex: EUR/MWh) of an area, as published by market operators.

  It can either be queried by zone identifier or by geolocation. The returned time range is controlled by providing start and end start times, whether these are in the past or in the future.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/price-day-ahead/modeled

  Modeled Day-ahead Price

  This endpoint exposes day-ahead prices (in local currency, ex: EUR/MWh) of an area, as modeled by Electricity Maps.

  The modeled day-ahead prices are always available up to a 72 hours horizon in the future.

  It can either be queried by zone identifier or by geolocation. The returned time range is controlled by providing start and end start times, whether these are in the past or in the future.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-load/past

  Past Total Load

  This endpoint retrieves a past flow-traced total load of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-load/past-range

  Past Range Total Load

  This endpoint retrieves the past flow-traced total load of an area within a given date range.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour. When the temporality is greater than hourly, the data is returned in MWh.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity. If you need more data, you can loop over time ranges. Ex: first recover data between the 2025-01-01 to 2025-01-10, then between the 2025-01-10 and 2025-01-20 etc etc.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-load/history

  Recent Total Load (last 24 hours)

  This endpoint retrieves the flow-traced total load of an area for the last 24 hours.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-load/latest

  Latest Total Load

  This endpoint retrieves the last flow-traced total load of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-load/forecast

  Forecasted Total Load

  This endpoint retrieves the most recent forecast of the flow-traced total load in an area.

  It can either be queried by zone identifier or by geolocation.

  By default, this endpoint returns 24 hours of forecasts. The forecasts span from horizon 0, which is the start of the current hour, to horizon 24.

  Example: If the date and time is currently 2024-03-02 13:12:39 GMT, then the forecasts will cover the range from 2024-03-02 13:00:00 GMT to 2024-03-03 13:00:00 GMT.

  You can supply an optional horizonHours query parameter to receive forecasts for a different time horizon (availability depends on your plan). If you specify 24 for the horizonHours parameter, you will receive 24 hours of forecasts. Accepted values are 24, 48 and 72 hours.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-reported-load/past

  Past Total Reported Load

  This endpoint retrieves a past total reported load of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-reported-load/past-range

  Past Range Total Reported Load

  This endpoint retrieves the past total reported load of an area within a given date range.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour. When the temporality is greater than hourly, the data is returned in MWh.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity. If you need more data, you can loop over time ranges. Ex: first recover data between the 2025-01-01 to 2025-01-10, then between the 2025-01-10 and 2025-01-20 etc etc.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-reported-load/history

  Recent Total Reported Load (last 24 hours)

  This endpoint retrieves the total reported load of an area for the last 24 hours.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-reported-load/latest

  Latest Total Reported Load

  This endpoint retrieves the last reported total load of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/total-reported-load/forecast

  Forecasted Total Reported Load

  This endpoint retrieves the most recent forecasted data about the total reported load in an area.

  It can either be queried by zone identifier or by geolocation.

  By default, this endpoint returns 24 hours of forecasts. The forecasts span from horizon 0, which is the start of the current hour, to horizon 24.

  Example: If the date and time is currently 2024-03-02 13:12:39 GMT, then the forecasts will cover the range from 2024-03-02 13:00:00 GMT to 2024-03-03 13:00:00 GMT.

  You can supply an optional horizonHours query parameter to receive forecasts for a different time horizon (availability depends on your plan). If you specify 24 for the horizonHours parameter, you will receive 24 hours of forecasts. Accepted values are 24, 48 and 72 hours.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/net-load/past

  Past Net Load

  The net load is the total electricity made available on the grid at a given point in time, minus solar and wind. Because Electricity Maps applies flow-tracing, this calculation takes imports and exports of solar and wind into account. Essentially, it represents the remaining load that must be met by other power sources, primarily fossil fuel plants, to maintain grid stability. This concept may also be referred to as net demand or net consumption. It is measured in megawatts (MW).

  This endpoint retrieves a past net load of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/net-load/past-range

  Past Range Net Load

  The net load is the total electricity made available on the grid at a given point in time, minus solar and wind. Because Electricity Maps applies flow-tracing, this calculation takes imports and exports of solar and wind into account. Essentially, it represents the remaining load that must be met by other power sources, primarily fossil fuel plants, to maintain grid stability. This concept may also be referred to as net demand or net consumption. It is measured in megawatts (MW).

  This endpoint retrieves the past net load of an area within a given date range.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour. When the temporality is greater than hourly, the data is returned in MWh.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity. If you need more data, you can loop over time ranges. Ex: first recover data between the 2025-01-01 to 2025-01-10, then between the 2025-01-10 and 2025-01-20 etc etc.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/net-load/history

  Recent Net Load (last 24 hours)

  The net load is the total electricity made available on the grid at a given point in time, minus solar and wind. Because Electricity Maps applies flow-tracing, this calculation takes imports and exports of solar and wind into account. Essentially, it represents the remaining load that must be met by other power sources, primarily fossil fuel plants, to maintain grid stability. This concept may also be referred to as net demand or net consumption. It is measured in megawatts (MW).

  This endpoint retrieves the net load of an area for the last 24 hours.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/net-load/latest

  Latest Net Load

  The net load is the total electricity made available on the grid at a given point in time, minus solar and wind. Because Electricity Maps applies flow-tracing, this calculation takes imports and exports of solar and wind into account. Essentially, it represents the remaining load that must be met by other power sources, primarily fossil fuel plants, to maintain grid stability. This concept may also be referred to as net demand or net consumption. It is measured in megawatts (MW).

  This endpoint retrieves the last known net load of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/net-load/forecast

  Forecasted Net Load

  The net load is the total electricity made available on the grid at a given point in time, minus solar and wind. Because Electricity Maps applies flow-tracing, this calculation takes imports and exports of solar and wind into account. Essentially, it represents the remaining load that must be met by other power sources, primarily fossil fuel plants, to maintain grid stability. This concept may also be referred to as net demand or net consumption. It is measured in megawatts (MW).

  This endpoint retrieves the most recent forecasted data about the net load in an area.

  It can either be queried by zone identifier or by geolocation.

  By default, this endpoint returns 24 hours of forecasts. The forecasts span from horizon 0, which is the start of the current hour, to horizon 24.

  Example: If the date and time is currently 2024-03-02 13:12:39 GMT, then the forecasts will cover the range from 2024-03-02 13:00:00 GMT to 2024-03-03 13:00:00 GMT.

  You can supply an optional horizonHours query parameter to receive forecasts for a different time horizon (availability depends on your plan). If you specify 24 for the horizonHours parameter, you will receive 24 hours of forecasts. Accepted values are 24, 48 and 72 hours.

  Attributes

  • zonestring

    A string representing the zone identifier

  • latstringoptional

    Latitude, if querying with a geolocation

  • lonstringoptional

    Longitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• POST

  /v3/carbon-aware-optimizer

  Carbon Aware Optimizer

  This endpoint is the base for the implementation of carbon-aware computing. For any flexible compute job, whether in time and/or location, the optimizer will determine the best execution time and location.

  Information about the job need to be provided in the request body. It should contain:

  • duration: Expected duration of the job, using the ISO8601 standard.
  • startWindow: Start of the optimization window, earliest timestamp at which the job can be scheduled.
  • endWindow: End of the optimization window, latest time at which the job can end.
  • locations: list of of data centers (see v3/data-centers), or a list of (longitude, latitude) coordinates.
  • optimizationMetric: The scheduler can use the flow-traced carbon intensity, (flow-traced_carbon_intensity), net load (net_load) or flow-traced renewable share (flow-traced_renewable_share) to determine the optimal execution time and location.

  Request Body

  Request

  Open in Playground

  Response
• POST

  /v3/smart-charging-optimizer

  Smart Charging

  This endpoint serves as the backbone of a smart charging feature. The optimizer will determine the best execution time for a charge, based on the location of the charger.

  Information about the job need to be provided in the request body. It should contain:

  • duration: Expected duration of the job, using the ISO8601 standard.
  • startWindow: Start of the optimization window, earliest timestamp at which the charge can be scheduled.
  • endWindow: End of the optimization window, latest time at which the charge can end.
  • locations: list of location parameters as (longitude, latitude) coordinates.
  • optimizationMetric: The scheduler can use the flow-traced carbon intensity, (flow-traced_carbon_intensity), net load (net_load) or flow-traced renewable share (flow-traced_renewable_share) to determine the optimal execution time and location.

  Request Body

  Request

  Open in Playground

  Response
• GET

  /v3/power-breakdown/past

  Past Power Breakdown

  The power-breakdown endpoints will be deprecated soon in favor of electricity-mix and electricity-flows endpoints.

  This endpoint retrieves a past power breakdown of an area.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour. When the aggregationPeriod parameter is used, data is returned in MWh.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • datetimedatetime (ISO)

    Date in ISO format

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/power-breakdown/past-range

  Past Range Power Breakdown

  The power-breakdown endpoints will be deprecated soon in favor of electricity-mix and electricity-flows endpoints.

  This endpoint retrieves a past power breakdown of an area within a given date range.

  It can either be queried by zone identifier or by geolocation.

  The default temporal granularity is 1 hour. When the temporality is greater than hourly, the data is returned in MWh.

  The time range is limited to 10 days (240 hours) for an hourly granularity, and to 100 days for a daily granularity.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly', 'daily', 'monthly', 'quarterly', and 'yearly'.

  Request

  Open in Playground

  Response
• GET

  /v3/power-breakdown/history

  Recent Power Breakdown (last 24 hours)

  The power-breakdown endpoints will be deprecated soon in favor of electricity-mix and electricity-flows endpoints.

  This endpoint retrieves the last 24 hours of data detailed information about the origin of electricity in an area.

  • "powerProduction" (in MW) represents the electricity produced in the zone, broken down by production type
  • "powerConsumption" (in MW) represents the electricity consumed in the zone, after taking into account imports and exports, and broken down by production type.
  • "powerExport" and "Power import" (in MW) represent the physical electricity flows at the zone border
  • "renewablePercentage" and "fossilFreePercentage" refers to the % of the power consumption breakdown coming from renewables or fossil-free power plants (renewables and nuclear).

  It can either be queried by zone identifier or by geolocation.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/power-breakdown/latest

  Latest Power Breakdown

  The power-breakdown endpoints will be deprecated soon in favor of electricity-mix and electricity-flows endpoints.

  This endpoint retrieves the last known data about the origin of electricity in an area.

  • "powerProduction" (in MW) represents the electricity produced in the zone, broken down by production type
  • "powerConsumption" (in MW) represents the electricity consumed in the zone, after taking into account imports and exports, and broken down by production type.
  • "powerExport" and "Power import" (in MW) represent the physical electricity flows at the zone border
  • "renewablePercentage" and "fossilFreePercentage" refers to the % of the power consumption breakdown coming from renewables or fossil-free power plants (renewables and nuclear). It can either be queried by zone identifier or by geolocation.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/power-breakdown/forecast

  Forecasted Power Breakdown

  The power-breakdown endpoints will be deprecated soon in favor of electricity-mix and electricity-flows endpoints.

  This endpoint retrieves the most recent forecasted data about the origin of electricity in an area.

  • "powerProduction" (in MW) represents the electricity produced in the zone, broken down by production type
  • "powerConsumption" (in MW) represents the electricity consumed in the zone, after taking into account imports and exports, and broken down by production type.
  • "powerExport" and "Power import" (in MW) represent the physical electricity flows at the zone border
  • "renewablePercentage" and "fossilFreePercentage" refers to the % of the power consumption breakdown coming from renewables or fossil-free power plants (renewables and nuclear)

  It can either be queried by zone identifier or by geolocation.

  By default, this endpoint returns 25 hours of forecasts. The forecasts span from horizon 0, which is the start of the current hour, to horizon 24.

  Example: If the date and time is currently 2024-03-02 13:12:39 GMT, then the forecasts will cover the range from 2024-03-02 13:00:00 GMT to 2024-03-03 13:00:00 GMT.

  You can supply an optional horizonHours query parameter to receive forecasts for a different time horizon (availability depends on your plan). If you specify 24 for the horizonHours parameter, you will receive 25 hours of forecasts. Accepted values are 6, 24, 48 and 72 hours.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • dataCenterRegionstringoptional

    Name of the region of the data center according to the provider, always lower case and dash separated, ex: europe-west1, if querying for a data center

  • horizonHoursnumberoptional

    A number indicating the horizon of the forecast returned. Accepted values are 6, 24, 48, 72 (availability depends on your plan).

  • temporalGranularitystringoptional

    A string indicating the temporal granularity of data to be returned. Default value is 'hourly' and supported values are '5_minutes', '15_minutes', 'hourly'.

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-intensity-level/latest

  Latest Carbon Intensity Level

  This endpoint returns a high, moderate, or low signal for the most recent hour that indicates how the current carbon intensity for a given zone compares to a rolling average of the previous 10 days.

  The thresholds for high, moderate, and low are as follows:

  • Low: 15% below average (ratio < 0.85)
  • Moderate: between 15% below and 15% above average (0.85 ≤ ratio ≤ 1.15)
  • High: 15% above average (ratio > 1.15)

  Attributes

  • zonestring

    A string representing the zone identifier

  • latstringoptional

    Latitude, if querying with a geolocation

  • lonstringoptional

    Longitude, if querying with a geolocation

  Request

  Open in Playground

  Response
• GET

  /v3/renewable-percentage-level/latest

  Latest Renewable Energy Percentage Level

  This endpoint returns a high, moderate, or low signal for the most recent hour that indicates how the current renewable energy percentage for a given zone compares to a rolling average of the previous 10 days.

  The thresholds for high, moderate, and low are as follows:

  • Low: 15% below average (ratio < 0.85)
  • Moderate: between 15% below and 15% above average (0.85 ≤ ratio ≤ 1.15)
  • High: 15% above average (ratio > 1.15)

  Attributes

  • zonestring

    A string representing the zone identifier

  • latstringoptional

    Latitude, if querying with a geolocation

  • lonstringoptional

    Longitude, if querying with a geolocation

  Request

  Open in Playground

  Response
• GET

  /v3/carbon-free-percentage-level/latest

  Latest Carbon-Free Energy Percentage Level

  This endpoint returns a high, moderate, or low signal for the most recent hour that indicates how the current carbon-free energy percentage for a given zone compares to a rolling average of the previous 10 days.

  The thresholds for high, moderate, and low are as follows:

  • Low: 15% below average (ratio < 0.85)
  • Moderate: between 15% below and 15% above average (0.85 ≤ ratio ≤ 1.15)
  • High: 15% above average (ratio > 1.15)

  Attributes

  • zonestring

    A string representing the zone identifier

  • latstringoptional

    Latitude, if querying with a geolocation

  • lonstringoptional

    Longitude, if querying with a geolocation

  Request

  Open in Playground

  Response
• GET

  /v3/updated-since

  Updated Since

  This endpoint returns a list of hours where our flow-traced consumption data has been updated since a specified date for a specified zone. The 'start' and 'end' parameters can be used to specify a limited timeframe in which to search. Furthermore, the 'threshold' parameter can be used to filter the timestamps to only include entries with a difference between 'datetime' and 'updated_at' higher than the threshold. It can either be queried by zone identifier or by geolocation.

  Access to this endpoint is only authorized if the token has access to one or more past endpoints.

  Attributes

  • zonestring

    A string representing the zone identifier

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • sincedatetime (ISO)

    Datetime in ISO format

  • startdatetime (ISO)

    Start date in ISO

  • enddatetime (ISO)

    End date in ISO (excluded)

  • limitnumberoptional

    limit of the number of entries to output (max 1000)

  • thresholdstringoptional

    Duration in ISO 8601 format, filter for entries to include those only where the difference between datetime and updated_at is higher than the threshold.

  • disableEstimationsbooleanoptional

    A boolean indicating if estimated data should be disabled

  Request

  Open in Playground

  Response
• GET

  /v3/zone

  Zone

  This endpoint allows to retrieve information about any Electricity Maps geographical zone.

  Typical use cases

  1. You can use this endpoint to match geographical coordinates with an Electricity Maps zone

  In this case, query the endpoint using geographical coordinates, ex: https://api.electricitymap.org/v3/zone?lat=50.9225922&lon=11.5035735

  2. You can also use this endpoint to retrieve more metadata about an Electricity Maps zone, such as the country it is located in, whether it has a parent or children zones etc.

  In this case, query the endpoint directly with the zone key, ex: https://api.electricitymap.org/v3/zone?zone=AU-NSW

  Attributes

  • lonstringoptional

    Longitude, if querying with a geolocation

  • latstringoptional

    Latitude, if querying with a geolocation

  • zonestringoptional

    Optional string representing the zone identifier

  Request

  Open in Playground

  Response
• GET

  /v3/zones

  Zones

  This endpoint lists Electricity Maps' zones

  Use cases

  1. When the endpoint is called without an auth-token, the endpoint will list all existing Electricity Maps' zones.
  2. If an auth-token is provided, the endpoint will list the access of the token. That includes all zones the token has access to, and for each zone, each authorized endpoint for the token.

  ["*"] means that all routes on a zone are accessible.

  Request

  Open in Playground

  Response
• GET

  /v3/data-centers

  Data centers

  This endpoint returns all information about data centers Electricity Maps and its contributors have mapped.

  Query parameters can be used to filter out data centers. That can be:

  • By zone
  • By cloudCenterProvider

  Attributes

  • zonestringoptional

    Optional string representing the zone identifier

  • latstringoptional

    Latitude, if querying with a geolocation

  • lonstringoptional

    Longitude, if querying with a geolocation

  • dataCenterProviderstringoptional

    Provider name for the data center, always lower case, ex: gcp, if querying for a data center

  • pagenumber

    Page for pagination

  • limitnumber

    Limit for pagination (number of returned elements in the result)

  Request

  Open in Playground

  Response