---
canonical_url: "https://docs.composio.dev/toolkits/electricity_maps"
markdown_url: "https://docs.composio.dev/toolkits/electricity_maps.md"
product: "platform"
version: null
last_updated: null
---

# Electricity Maps

Electricity Maps provides grid carbon intensity, electricity mix, power flow, load, renewable energy, and day-ahead price data and forecasts by zone.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 49
- **Triggers:** 0
- **Slug:** `ELECTRICITY_MAPS`
- **Version:** 00000000_00

## Tools

### Get Carbon Intensity Forecast

**Slug:** `ELECTRICITY_MAPS_GET_CARBON_INTENSITY_FORECAST`

Get a grid-average or fossil-only carbon intensity forecast for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("grid_average" | "fossil_only") | No | Carbon-intensity calculation to return: grid_average covers all generation in the grid mix; fossil_only covers fossil-fuel generation only and excludes non-fossil generation. |
| `horizon_hours` | integer ("6" | "24" | "48" | "72") | No | Number of hours ahead to forecast. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | Temporal granularity of the forecast. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Carbon Intensity History

**Slug:** `ELECTRICITY_MAPS_GET_CARBON_INTENSITY_HISTORY`

Get the last 24 hours of grid-average or fossil-only carbon intensity for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("grid_average" | "fossil_only") | No | Carbon-intensity calculation to return: grid_average covers all generation in the grid mix; fossil_only covers fossil-fuel generation only and excludes non-fossil generation. |
| `flow_traced` | boolean | No | Whether grid-average values account for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the response. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | Temporal granularity of the history. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Carbon Intensity Latest

**Slug:** `ELECTRICITY_MAPS_GET_CARBON_INTENSITY_LATEST`

Get the latest grid-average or fossil-only carbon intensity for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("grid_average" | "fossil_only") | No | Carbon-intensity calculation to return: grid_average covers all generation in the grid mix; fossil_only covers fossil-fuel generation only and excludes non-fossil generation. |
| `flow_traced` | boolean | No | Whether grid-average values account for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the response. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | Temporal granularity of the value. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Carbon Intensity Past

**Slug:** `ELECTRICITY_MAPS_GET_CARBON_INTENSITY_PAST`

Get grid-average or fossil-only carbon intensity for a zone at a given datetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("grid_average" | "fossil_only") | No | Carbon-intensity calculation to return: grid_average covers all generation in the grid mix; fossil_only covers fossil-fuel generation only and excludes non-fossil generation. |
| `datetime` | string | Yes | ISO 8601 datetime identifying the value to retrieve. |
| `flow_traced` | boolean | No | Whether grid-average values account for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the response. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | Temporal granularity of the value. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Carbon Intensity Past Range

**Slug:** `ELECTRICITY_MAPS_GET_CARBON_INTENSITY_PAST_RANGE`

Get grid-average or fossil-only carbon intensity for a zone over a datetime range. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Exclusive ISO 8601 end datetime. |
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `start` | string | Yes | Inclusive ISO 8601 start datetime. |
| `metric` | string ("grid_average" | "fossil_only") | No | Carbon-intensity calculation to return: grid_average covers all generation in the grid mix; fossil_only covers fossil-fuel generation only and excludes non-fossil generation. |
| `flow_traced` | boolean | No | Whether grid-average values account for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the response. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | Temporal granularity of the values. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Flows Forecast

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_FLOWS_FORECAST`

Get the electricity flows forecast for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `horizon_hours` | integer ("6" | "24" | "48" | "72") | No | The number of hours ahead to forecast. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Flows History

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_FLOWS_HISTORY`

Get the last 24 hours of electricity flows for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Flows Latest

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_FLOWS_LATEST`

Get the latest electricity flows for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Flows Past

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_FLOWS_PAST`

Get the electricity flows for a zone at a given datetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `datetime` | string | Yes | The datetime to get the data for. By default this needs to be the specific hour unless another temporal granularity is requested. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Flows Past Range

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_FLOWS_PAST_RANGE`

Get the electricity flows for a zone and a given datetime range. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | The end datetime to get the data for. |
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `start` | string | Yes | The start datetime to get the data for. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | The temporal granularity of the data to get. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Mix Forecast

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_MIX_FORECAST`

Get the electricity mix forecast for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `horizon_hours` | integer ("6" | "24" | "48" | "72") | No | The number of hours ahead to forecast. |
| `breakdown_type` | string ("normal" | "flow-traced") | No | Breakdown method: normal reports local generation with flows, while flow-traced attributes imports to their generation sources. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Mix History

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_MIX_HISTORY`

Get the last 24 hours of electricity mix for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `breakdown_type` | string ("normal" | "flow-traced") | No | Breakdown method: normal reports local generation with flows, while flow-traced attributes imports to their generation sources. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Mix Latest

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_MIX_LATEST`

Get the latest electricity mix for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `breakdown_type` | string ("normal" | "flow-traced") | No | Breakdown method: normal reports local generation with flows, while flow-traced attributes imports to their generation sources. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Mix Past

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_MIX_PAST`

Get the electricity mix for a zone at a given datetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `datetime` | string | Yes | The datetime to get the data for. Use the specific hour unless requesting another temporal granularity. |
| `breakdown_type` | string ("normal" | "flow-traced") | No | Breakdown method: normal reports local generation with flows, while flow-traced attributes imports to their generation sources. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Mix Past Range

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_MIX_PAST_RANGE`

Get the electricity mix for a zone and a given datetime range. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | The end datetime to get the data for. |
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `start` | string | Yes | The start datetime to get the data for. |
| `breakdown_type` | string ("normal" | "flow-traced") | No | Breakdown method: normal reports local generation with flows, while flow-traced attributes imports to their generation sources. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | The temporal granularity of the data to get. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Source Forecast

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_SOURCE_FORECAST`

Get forecasted electricity generation values for the selected source_type in a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `flow_traced` | boolean | No | Whether values are flow-traced. True returns consumption-based values; false returns generation-based values. |
| `source_type` | string ("nuclear" | "geothermal" | "biomass" | "coal" | "wind" | "solar" | "hydro" | "gas" | "oil" | "unknown" | "hydro-discharge" | "battery-discharge") | Yes | The electricity generation source to get the data for. |
| `horizon_hours` | integer ("6" | "24" | "48" | "72") | No | The number of hours ahead to forecast. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Source History

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_SOURCE_HISTORY`

Get the last 24 hours of electricity generation values for the selected source_type in a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `flow_traced` | boolean | No | Whether values are flow-traced. True returns consumption-based values; false returns generation-based values. |
| `source_type` | string ("nuclear" | "geothermal" | "biomass" | "coal" | "wind" | "solar" | "hydro" | "gas" | "oil" | "unknown" | "hydro-discharge" | "battery-discharge") | Yes | The electricity generation source to get the data for. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Source Latest

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_SOURCE_LATEST`

Get the latest electricity generation values for the selected source_type in a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `flow_traced` | boolean | No | Whether values are flow-traced. True returns consumption-based values; false returns generation-based values. |
| `source_type` | string ("nuclear" | "geothermal" | "biomass" | "coal" | "wind" | "solar" | "hydro" | "gas" | "oil" | "unknown" | "hydro-discharge" | "battery-discharge") | Yes | The electricity generation source to get the data for. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Source Past

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_SOURCE_PAST`

Get electricity generation values for the selected source_type in a zone at a given datetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `datetime` | string | Yes | The datetime to get the data for. By default this must identify the specific hour unless another temporal granularity is requested. |
| `flow_traced` | boolean | No | Whether values are flow-traced. True returns consumption-based values; false returns generation-based values. |
| `source_type` | string ("nuclear" | "geothermal" | "biomass" | "coal" | "wind" | "solar" | "hydro" | "gas" | "oil" | "unknown" | "hydro-discharge" | "battery-discharge") | Yes | The electricity generation source to get the data for. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Electricity Source Past Range

**Slug:** `ELECTRICITY_MAPS_GET_ELECTRICITY_SOURCE_PAST_RANGE`

Get electricity generation values for the selected source_type in a zone over a given datetime range. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | The end datetime to get the data for. |
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `start` | string | Yes | The start datetime to get the data for. |
| `flow_traced` | boolean | No | Whether values are flow-traced. True returns consumption-based values; false returns generation-based values. |
| `source_type` | string ("nuclear" | "geothermal" | "biomass" | "coal" | "wind" | "solar" | "hydro" | "gas" | "oil" | "unknown" | "hydro-discharge" | "battery-discharge") | Yes | The electricity generation source to get the data for. |
| `include_estimated` | boolean | No | Whether to include estimated data points. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | The temporal granularity of the data to get. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Energy Share Forecast

**Slug:** `ELECTRICITY_MAPS_GET_ENERGY_SHARE_FORECAST`

Get the carbon-free or renewable electricity share forecast for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("carbon_free" | "renewable") | Yes | Energy-share metric: carbon-free or renewable electricity. |
| `flow_traced` | boolean | No | Whether values account for electricity flows. True returns consumption-based values; false returns generation-based values. |
| `horizon_hours` | integer ("6" | "24" | "48" | "72") | No | Number of hours ahead to forecast. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | Temporal granularity of the forecast. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Energy Share History

**Slug:** `ELECTRICITY_MAPS_GET_ENERGY_SHARE_HISTORY`

Get the last 24 hours of carbon-free or renewable electricity share for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("carbon_free" | "renewable") | Yes | Energy-share metric: carbon-free or renewable electricity. |
| `flow_traced` | boolean | No | Whether values account for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the result. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | Temporal granularity of the history. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Energy Share Latest

**Slug:** `ELECTRICITY_MAPS_GET_ENERGY_SHARE_LATEST`

Get the latest carbon-free or renewable electricity share for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("carbon_free" | "renewable") | Yes | Energy-share metric: carbon-free or renewable electricity. |
| `flow_traced` | boolean | No | Whether values account for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the result. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | Temporal granularity of the data. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Energy Share Past

**Slug:** `ELECTRICITY_MAPS_GET_ENERGY_SHARE_PAST`

Get the carbon-free or renewable electricity share at a given datetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("carbon_free" | "renewable") | Yes | Energy-share metric: carbon-free or renewable electricity. |
| `datetime` | string | Yes | Datetime to retrieve in ISO 8601 format. |
| `flow_traced` | boolean | No | Whether values account for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the result. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | Temporal granularity of the data. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Energy Share Past Range

**Slug:** `ELECTRICITY_MAPS_GET_ENERGY_SHARE_PAST_RANGE`

Get carbon-free or renewable electricity share values over a datetime range. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | End datetime in ISO 8601 format. |
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `start` | string | Yes | Start datetime in ISO 8601 format. |
| `metric` | string ("carbon_free" | "renewable") | Yes | Energy-share metric: carbon-free or renewable electricity. |
| `flow_traced` | boolean | No | Whether values account for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the result. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | Temporal granularity of the data. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Grid Level Forecast

**Slug:** `ELECTRICITY_MAPS_GET_GRID_LEVEL_FORECAST`

Get forecasted carbon-intensity, carbon-free-percentage, or renewable-percentage grid levels. Levels are classified on hourly data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("carbon_intensity" | "carbon_free_percentage" | "renewable_percentage") | Yes | Grid-level metric to classify. |
| `horizon_hours` | integer ("6" | "24" | "48" | "72") | No | Number of hours ahead to forecast. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Grid Level Latest

**Slug:** `ELECTRICITY_MAPS_GET_GRID_LEVEL_LATEST`

Get the latest carbon-intensity, carbon-free-percentage, or renewable-percentage grid level. Levels are classified on hourly data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("carbon_intensity" | "carbon_free_percentage" | "renewable_percentage") | Yes | Grid-level metric to classify. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Grid Level Past

**Slug:** `ELECTRICITY_MAPS_GET_GRID_LEVEL_PAST`

Get a carbon-intensity, carbon-free-percentage, or renewable-percentage grid level for an exact past hourly bucket.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("carbon_intensity" | "carbon_free_percentage" | "renewable_percentage") | Yes | Grid-level metric to classify. |
| `datetime` | string | Yes | ISO 8601 datetime identifying the exact hourly bucket to retrieve. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Grid Level Past Range

**Slug:** `ELECTRICITY_MAPS_GET_GRID_LEVEL_PAST_RANGE`

Get carbon-intensity, carbon-free-percentage, or renewable-percentage grid levels over an hourly range of at most 10 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | End of the hourly range in ISO 8601 format. |
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `start` | string | Yes | Start of the hourly range in ISO 8601 format. |
| `metric` | string ("carbon_intensity" | "carbon_free_percentage" | "renewable_percentage") | Yes | Grid-level metric to classify. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Load Forecast

**Slug:** `ELECTRICITY_MAPS_GET_LOAD_FORECAST`

Get a net, total, or total-reported electricity load forecast.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("net" | "total" | "total_reported") | Yes | Load calculation to return: net accounts for generation and electricity flows; total is estimated total demand; total_reported is demand reported by the grid operator. |
| `flow_traced` | boolean | No | Whether net load accounts for electricity flows. |
| `horizon_hours` | integer ("6" | "24" | "48" | "72") | No | Number of hours ahead to forecast. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | Temporal granularity of the forecast. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Load History

**Slug:** `ELECTRICITY_MAPS_GET_LOAD_HISTORY`

Get the last 24 hours of net, total, or total-reported load.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("net" | "total" | "total_reported") | Yes | Load calculation to return: net accounts for generation and electricity flows; total is estimated total demand; total_reported is demand reported by the grid operator. |
| `flow_traced` | boolean | No | Whether net load accounts for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the response. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | Temporal granularity of the history. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Load Latest

**Slug:** `ELECTRICITY_MAPS_GET_LOAD_LATEST`

Get the latest net, total, or total-reported electricity load value.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("net" | "total" | "total_reported") | Yes | Load calculation to return: net accounts for generation and electricity flows; total is estimated total demand; total_reported is demand reported by the grid operator. |
| `flow_traced` | boolean | No | Whether net load accounts for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the response. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | Temporal granularity of the value. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Load Past

**Slug:** `ELECTRICITY_MAPS_GET_LOAD_PAST`

Get net, total, or total-reported load at a given datetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `metric` | string ("net" | "total" | "total_reported") | Yes | Load calculation to return: net accounts for generation and electricity flows; total is estimated total demand; total_reported is demand reported by the grid operator. |
| `datetime` | string | Yes | ISO 8601 datetime identifying the value to retrieve. |
| `flow_traced` | boolean | No | Whether net load accounts for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the response. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | Temporal granularity of the value. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Load Past Range

**Slug:** `ELECTRICITY_MAPS_GET_LOAD_PAST_RANGE`

Get net, total, or total-reported load over a datetime range. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Exclusive ISO 8601 end datetime. |
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `start` | string | Yes | Inclusive ISO 8601 start datetime. |
| `metric` | string ("net" | "total" | "total_reported") | Yes | Load calculation to return: net accounts for generation and electricity flows; total is estimated total demand; total_reported is demand reported by the grid operator. |
| `flow_traced` | boolean | No | Whether net load accounts for electricity flows. |
| `include_estimated` | boolean | No | Include estimated data points in the response. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | Emission-factor methodology to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | Temporal granularity of the values. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly. |
| `disable_caller_lookup` | boolean | No | Disable caller-IP location lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Locational Marginal Price Actual

**Slug:** `ELECTRICITY_MAPS_GET_LOCATIONAL_MARGINAL_PRICE_DAY_AHEAD_ACTUAL`

Get actual day-ahead locational marginal prices for a pricing node and datetime range. Addressed by node, not zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | The range end in ISO 8601 format. Must be later than start. |
| `node` | string | Yes | A pricing node identifier. LMP endpoints are addressed by node, not zone. |
| `start` | string | Yes | The range start in ISO 8601 format. Must be earlier than end. |
| `temporal_granularity` | string ("hourly") | No | The temporal granularity of the data to get. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Locational Marginal Price History

**Slug:** `ELECTRICITY_MAPS_GET_LOCATIONAL_MARGINAL_PRICE_DAY_AHEAD_HISTORY`

Get the last 24 hours of day-ahead locational marginal prices for a pricing node. Addressed by node, not zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `node` | string | Yes | A pricing node identifier. LMP endpoints are addressed by node, not zone. |
| `temporal_granularity` | string ("hourly") | No | The temporal granularity of the data to get. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Locational Marginal Price Latest

**Slug:** `ELECTRICITY_MAPS_GET_LOCATIONAL_MARGINAL_PRICE_DAY_AHEAD_LATEST`

Get the latest day-ahead locational marginal price for a pricing node. Addressed by node, not zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `node` | string | Yes | A pricing node identifier. LMP endpoints are addressed by node, not zone. |
| `temporal_granularity` | string ("hourly") | No | The temporal granularity of the data to get. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Locational Marginal Price Past

**Slug:** `ELECTRICITY_MAPS_GET_LOCATIONAL_MARGINAL_PRICE_DAY_AHEAD_PAST`

Get the day-ahead locational marginal price for a pricing node at a given datetime. Addressed by node, not zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `node` | string | Yes | A pricing node identifier. LMP endpoints are addressed by node, not zone. |
| `datetime` | string | Yes | The datetime to get data for, in ISO 8601 format. |
| `temporal_granularity` | string ("hourly") | No | The temporal granularity of the data to get. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Locational Marginal Price Past Range

**Slug:** `ELECTRICITY_MAPS_GET_LOCATIONAL_MARGINAL_PRICE_DAY_AHEAD_PAST_RANGE`

Get day-ahead locational marginal prices for a pricing node and past datetime range of at most 10 days. Addressed by node, not zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | The end datetime to get the data for, in ISO 8601 format. |
| `node` | string | Yes | A pricing node identifier. LMP endpoints are addressed by node, not zone. |
| `start` | string | Yes | The start datetime to get the data for, in ISO 8601 format. |
| `temporal_granularity` | string ("hourly") | No | The temporal granularity of the data to get. Maximum range: 10 days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Price Actual

**Slug:** `ELECTRICITY_MAPS_GET_PRICE_DAY_AHEAD_ACTUAL`

Get settled and published day-ahead prices for a zone and datetime range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | The range end in ISO 8601 format. Must be later than start. |
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `start` | string | Yes | The range start in ISO 8601 format. Must be earlier than end. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Price Combined

**Slug:** `ELECTRICITY_MAPS_GET_PRICE_DAY_AHEAD_COMBINED`

Get both actual and forecasted day-ahead prices for a zone in a single response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `horizon_hours` | integer ("6" | "24" | "48" | "72") | No | The number of hours ahead to forecast. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Price Forecast

**Slug:** `ELECTRICITY_MAPS_GET_PRICE_DAY_AHEAD_FORECAST`

Get the day-ahead price forecast for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `horizon_hours` | integer ("6" | "24" | "48" | "72") | No | The number of hours ahead to forecast. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Price History

**Slug:** `ELECTRICITY_MAPS_GET_PRICE_DAY_AHEAD_HISTORY`

Get the last 24 hours of day-ahead price for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `disable_estimations` | boolean | No | If true, the response will exclude estimated data points. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | The type of emission factors to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Price Latest

**Slug:** `ELECTRICITY_MAPS_GET_PRICE_DAY_AHEAD_LATEST`

Get the latest day-ahead price for a zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `disable_estimations` | boolean | No | If true, the response will exclude estimated data points. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | The type of emission factors to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Price Past

**Slug:** `ELECTRICITY_MAPS_GET_PRICE_DAY_AHEAD_PAST`

Get the day-ahead price for a zone at a given datetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `datetime` | string | Yes | The datetime to get the data for. By default this needs to be the specific hour unless another temporal granularity is requested. |
| `disable_estimations` | boolean | No | If true, the response will exclude estimated data points. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | The type of emission factors to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | The temporal granularity of the data to get. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Day-Ahead Price Past Range

**Slug:** `ELECTRICITY_MAPS_GET_PRICE_DAY_AHEAD_PAST_RANGE`

Get the day-ahead price for a zone and a given datetime range. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | The end datetime to get the data for. |
| `lat` | number | No | Latitude of the location to get the data for. |
| `lon` | number | No | Longitude of the location to get the data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `start` | string | Yes | The start datetime to get the data for. |
| `disable_estimations` | boolean | No | If true, the response will exclude estimated data points. |
| `emission_factor_type` | string ("direct" | "lifecycle") | No | The type of emission factors to use. |
| `temporal_granularity` | string ("5_minutes" | "15_minutes" | "hourly" | "daily" | "monthly" | "quarterly" | "yearly") | No | The temporal granularity of the data to get. Maximum range: 3 days for 5_minutes, 4 days for 15_minutes, 10 days for hourly, 365 days for daily, and 30 years for monthly, quarterly, or yearly. |
| `disable_caller_lookup` | boolean | No | If true, the fallback IP-based zone lookup will not be performed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Zone

**Slug:** `ELECTRICITY_MAPS_GET_ZONE`

Get metadata for a single Electricity Maps zone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude of the location to resolve to a zone. |
| `lon` | number | No | Longitude of the location to resolve to a zone. |
| `zone` | string | No | An Electricity Maps zone key. |
| `disable_caller_lookup` | boolean | No | If true, do not use the caller's IP address to infer a zone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Updates Since

**Slug:** `ELECTRICITY_MAPS_LIST_UPDATES_SINCE`

List data points for a zone that have been updated since a given datetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | End of the data interval as an ISO 8601 datetime. |
| `lat` | number | No | Latitude of the location to get data for. |
| `lon` | number | No | Longitude of the location to get data for. |
| `zone` | string | No | An Electricity Maps zone key. |
| `limit` | integer | No | Maximum number of updates to return, from 1 to 1000. |
| `since` | string | Yes | Only return data points updated since this ISO 8601 datetime. |
| `start` | string | Yes | Start of the data interval as an ISO 8601 datetime. |
| `threshold` | string | No | ISO 8601 duration threshold for reporting changes. |
| `disable_estimations` | boolean | No | If true, exclude estimated data points. |
| `disable_caller_lookup` | boolean | No | If true, do not use the caller's IP address to infer a zone. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Zones

**Slug:** `ELECTRICITY_MAPS_LIST_ZONES`

List all commercially available Electricity Maps zones. Each top-level key is a zone key; with an API key, its value can include the endpoints available to that key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
