hass.tibber_prices/docs/user/versioned_docs/version-v0.31.0/chart-actions.md

# Chart & Visualization Actions

Actions for generating chart data and ApexCharts configurations from your Tibber price data.

:::tip Entity ID tip
`<home_name>` is a placeholder for your Tibber home display name in Home Assistant. Entity IDs are derived from the displayed name (localized), so the exact slug may differ. **Can't find a sensor?** Use the **[Entity Reference (All Languages)](sensor-reference.md)** to search by name in your language.
:::

---

## tibber_prices.get_chartdata

**Purpose:** Returns electricity price data in chart-friendly formats for visualization and analysis.

**Key Features:**

-   **Flexible Output Formats**: Array of objects or array of arrays
-   **Time Range Selection**: Filter by day (yesterday, today, tomorrow)
-   **Price Filtering**: Filter by price level or rating
-   **Period Support**: Return best/peak price period summaries instead of intervals
-   **Resolution Control**: Interval (15-minute) or hourly aggregation
-   **Customizable Field Names**: Rename output fields to match your chart library
-   **Currency Control**: Override integration default - use base (€/kWh, kr/kWh) or subunit (ct/kWh, øre/kWh)

**Basic Example:**

<details>
<summary>Show YAML: Chart Data Action</summary>

```yaml
service: tibber_prices.get_chartdata
data:
    entry_id: YOUR_CONFIG_ENTRY_ID
    day: ["today", "tomorrow"]
    output_format: array_of_objects
response_variable: chart_data
```

</details>

**Response Format:**

<details>
<summary>Show JSON: Chart Data Response</summary>

```json
{
    "data": [
        {
            "start_time": "2025-11-17T00:00:00+01:00",
            "price_per_kwh": 0.2534
        },
        {
            "start_time": "2025-11-17T00:15:00+01:00",
            "price_per_kwh": 0.2498
        }
    ]
}
```

</details>

**Common Parameters:**

| Parameter        | Description                                 | Default                 |
| ---------------- | ------------------------------------------- | ----------------------- |
| `entry_id`       | Config entry ID (optional — auto-selects if only one home) | Auto |
| `day`            | Days to include: yesterday, today, tomorrow | `["today", "tomorrow"]` |
| `output_format`  | `array_of_objects` or `array_of_arrays`     | `array_of_objects`      |
| `resolution`     | `interval` (15-min) or `hourly`             | `interval`              |
| `price_source`   | Primary price series: `total`, `energy`, or `tax` | `total`           |
| `subunit_currency` | Override display mode: `true` for subunit (ct/øre), `false` for base (€/kr) | Integration setting |
| `round_decimals` | Decimal places (0-10)                       | 2 (subunit) or 4 (base) |

**Rolling Window Mode:**

Omit the `day` parameter to get a dynamic 48-hour rolling window that automatically adapts to data availability:

<details>
<summary>Show YAML: Rolling Window Mode</summary>

```yaml
service: tibber_prices.get_chartdata
data:
    entry_id: YOUR_CONFIG_ENTRY_ID
    # Omit 'day' for rolling window
    output_format: array_of_objects
response_variable: chart_data
```

</details>

**Behavior:**
-   **When tomorrow data available** (typically after ~13:00): Returns today + tomorrow
-   **When tomorrow data not available**: Returns yesterday + today

This is useful for charts that should always show a 48-hour window without manual day selection.

**Period Filter Example:**

Get best price periods as summaries instead of intervals:

<details>
<summary>Show YAML: Period Filter</summary>

```yaml
service: tibber_prices.get_chartdata
data:
    entry_id: YOUR_CONFIG_ENTRY_ID
    period_filter: best_price # or peak_price
    day: ["today", "tomorrow"]
    include_level: true
    include_rating_level: true
response_variable: periods
```

</details>

**Advanced Filtering:**

<details>
<summary>Show YAML: Advanced Filtering</summary>

```yaml
service: tibber_prices.get_chartdata
data:
    entry_id: YOUR_CONFIG_ENTRY_ID
    level_filter: ["VERY_CHEAP", "CHEAP"] # Only cheap periods
    rating_level_filter: ["LOW"] # Only low-rated prices
    insert_nulls: segments # Add nulls at segment boundaries
```

</details>

**Complete Documentation:**

For detailed parameter descriptions, open **Developer Tools → Actions** and select `tibber_prices.get_chartdata`. The inline documentation is stored in `services.yaml` because actions are backed by services.

### Price Source (`price_source`)

By default, charts use the **total** price (energy + taxes + fees) as the main price series. With `price_source` you can switch the **primary** value to a single component instead:

| Value | Main price series |
|-------|-------------------|
| `total` (default) | Full price including energy, taxes, and fees |
| `energy` | Raw spot/energy price only (excluding taxes and fees) |
| `tax` | Tax and fee component only |

<details>
<summary>Show YAML: Chart based on the raw energy price</summary>

```yaml
service: tibber_prices.get_chartdata
data:
    entry_id: YOUR_CONFIG_ENTRY_ID
    day: ["today", "tomorrow"]
    price_source: energy # main price = spot price only
response_variable: chart_data
```

</details>

:::tip `price_source` vs. `include_energy` / `include_tax`
These solve different problems:

- **`price_source`** changes *which* component becomes the **main** price value (one series).
- **`include_energy` / `include_tax`** (see below) keep the total price as main value but **add extra fields** so you can show energy and tax **alongside** the total in the same chart.
:::

This parameter also applies to [`get_apexcharts_yaml`](#tibber_pricesget_apexcharts_yaml).

### Energy & Tax Fields

You can include the raw energy price (spot price) and/or tax component in chart data output. This is useful for visualizing how the total price is composed over time, or for feed-in calculations.

| Parameter | Description | Default |
|-----------|-------------|---------|
| `include_energy` | Include raw energy/spot price per data point | `false` |
| `include_tax` | Include tax/fees component per data point | `false` |
| `energy_field` | Custom field name for energy price | `energy_price` |
| `tax_field` | Custom field name for tax | `tax` |

**Example: Chart with price composition**

<details>
<summary>Show YAML: Energy and Tax Fields</summary>

```yaml
service: tibber_prices.get_chartdata
data:
    entry_id: YOUR_CONFIG_ENTRY_ID
    day: ["today", "tomorrow"]
    include_energy: true
    include_tax: true
response_variable: chart_data
```

</details>

Returns data points like:

<details>
<summary>Show JSON: Returns data points like</summary>

```json
{
    "start_time": "2025-11-17T14:00:00+01:00",
    "price_per_kwh": 25.34,
    "energy_price": 12.18,
    "tax": 13.16
}
```

</details>

**Use case — Solar feed-in chart:** Overlay the energy price (what you earn by exporting) alongside the total price to visualize the best export windows. See [Energy & Tax Attributes](sensors-energy-tax.md) for more use cases.

---

## tibber_prices.get_apexcharts_yaml

> ⚠️ **IMPORTANT:** This action generates a **basic example configuration** as a starting point, NOT a complete solution for all ApexCharts features.
>
> This integration is primarily a **data provider**. The generated YAML demonstrates how to use the `get_chartdata` action to fetch price data. Due to the segmented nature of our data (different time periods per series) and the use of Home Assistant's service API instead of entity attributes, many advanced ApexCharts features (like `in_header`, certain transformations) are **not compatible** or require manual customization.
>
> **You are welcome to customize** the generated YAML for your specific needs, but comprehensive ApexCharts configuration support is beyond the scope of this integration. Community contributions with improved configurations are always appreciated!
>
> **For custom solutions:** Use the `get_chartdata` action directly to build your own charts with full control over the data format and visualization.

**Purpose:** Generates a basic ApexCharts card YAML configuration example for visualizing electricity prices with automatic color-coding by price level.

**Prerequisites:**
- [ApexCharts Card](https://github.com/RomRider/apexcharts-card) (required for all configurations)
- [Config Template Card](https://github.com/iantrich/config-template-card) (required only for rolling window modes - enables dynamic Y-axis scaling)

**Key Features:**

- **Automatic Color-Coded Series**: Separate series for each price level (VERY_CHEAP, CHEAP, NORMAL, EXPENSIVE, VERY_EXPENSIVE) or rating (LOW, NORMAL, HIGH)
- **Dynamic Y-Axis Scaling**: Rolling window modes automatically use `chart_metadata` sensor for optimal Y-axis bounds
- **Best Price Period Highlights**: Optional vertical bands showing detected best price periods
- **Translated Labels**: Automatically uses your Home Assistant language setting
- **Clean Gap Visualization**: Proper NULL insertion for missing data segments

**Quick Example:**

<details>
<summary>Show YAML: Quick Example</summary>

```yaml
service: tibber_prices.get_apexcharts_yaml
data:
    entry_id: YOUR_CONFIG_ENTRY_ID
    day: today  # Optional: yesterday, today, tomorrow, rolling_window, rolling_window_autozoom
    level_type: rating_level  # or "level" for 5-level classification
    highlight_best_price: true  # Show best price period overlays
response_variable: apexcharts_config
```

</details>

**Day Parameter Options:**

- **Fixed days** (`yesterday`, `today`, `tomorrow`): Static 24-hour views, no additional dependencies
- **Rolling Window** (default when omitted or `rolling_window`): Dynamic 48-hour window that automatically shifts between yesterday+today and today+tomorrow based on data availability
  - **Includes dynamic Y-axis scaling** via `chart_metadata` sensor
- **Rolling Window (Auto-Zoom)** (`rolling_window_autozoom`): Same as rolling window, but additionally zooms in progressively (2h lookback + remaining time until midnight, graph span decreases every 15 minutes)
  - **Includes dynamic Y-axis scaling** via `chart_metadata` sensor

**Dynamic Y-Axis Scaling (Rolling Window Modes):**

Rolling window configurations automatically integrate with the `chart_metadata` sensor for optimal chart appearance:

- **Automatic bounds**: Y-axis min/max adjust to data range
- **No manual configuration**: Works out of the box if sensor is enabled
- **Fallback behavior**: If sensor is disabled, uses ApexCharts auto-scaling
- **Real-time updates**: Y-axis adapts when price data changes

**Example: Today's Prices (Static View)**

<details>
<summary>Show YAML: Today Static View</summary>

```yaml
service: tibber_prices.get_apexcharts_yaml
data:
    entry_id: YOUR_CONFIG_ENTRY_ID
    day: today
    level_type: rating_level
response_variable: config

# Use in dashboard:
type: custom:apexcharts-card
# ... paste generated config
```

</details>

**Example: Rolling 48h Window (Dynamic View)**

<details>
<summary>Show YAML: Rolling 48h Dynamic View</summary>

```yaml
service: tibber_prices.get_apexcharts_yaml
data:
    entry_id: YOUR_CONFIG_ENTRY_ID
    # Omit 'day' for rolling window (or use 'rolling_window')
    level_type: level  # 5-level classification
    highlight_best_price: true
response_variable: config

# Use in dashboard:
type: custom:config-template-card
entities:
    - binary_sensor.<home_name>_tomorrow_s_data_available
    - sensor.<home_name>_chart_metadata  # For dynamic Y-axis
card:
    # ... paste generated config
```

</details>

**Level Type Options:**

- **`rating_level`** (default): 3 series (LOW, NORMAL, HIGH) - based on your personal thresholds
- **`level`**: 5 series (VERY_CHEAP, CHEAP, NORMAL, EXPENSIVE, VERY_EXPENSIVE) - absolute price ranges

**Price Source Option:**

Like `get_chartdata`, this action accepts a `price_source` parameter (`total`, `energy`, or `tax`) to choose which price component the generated chart plots. Defaults to `total`. See [Price Source](#price-source-price_source) above for details.

**Best Price Period Highlights:**

When `highlight_best_price: true`:
- Vertical bands overlay the chart showing detected best price periods
- Tooltip shows "Best Price Period" label when hovering over highlighted areas
- Only appears when best price periods are configured and detected

**Important Notes:**

- **Config Template Card** is only required for rolling window modes (enables dynamic Y-axis)
- Fixed day views (`today`, `tomorrow`, `yesterday`) work with ApexCharts Card alone
- Generated YAML is a starting point - customize colors, styling, features as needed
- All labels are automatically translated to your Home Assistant language

Use the response in Lovelace dashboards by copying the generated YAML.

**Documentation:** Refer to **Developer Tools → Actions** for descriptions of the fields exposed by this action.

---

## Migration from Chart Data Export Sensor

If you're still using the `sensor.<home_name>_chart_data_export` sensor, consider migrating to the `tibber_prices.get_chartdata` action:

**Benefits:**

-   No HA restart required for configuration changes
-   More flexible filtering and formatting options
-   Better performance (on-demand instead of polling)
-   Future-proof (active development)

**Migration Steps:**

1. Note your current sensor configuration (Step 7 in Options Flow)
2. Create automation/script that calls `tibber_prices.get_chartdata` with the same parameters
3. Test the new approach
4. Disable the old sensor when satisfied