2026.6.3
Home ▸ Actions

Get energy prices

The Get energy prices action fetches the dynamic energy prices from EnergyZero for a period you choose.

This action returns its result in a response variable, which you can use in later steps of the same automation or script, for example to show the prices in a template sensor.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To get energy prices from an automation or a script:

  1. Go to Settings > Automations & scenes.
  2. Open an existing automation or script, or select Create automation > Create new automation.
  3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
  4. In the Then do section, select Add action.
  5. From the search box, search for and select EnergyZero: Get energy prices.
  6. Select the Config entry to use, and choose whether to include VAT. Optionally, set a Start and End.
  7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Config entry (Required)

The EnergyZero config entry to use for this action.
Including VAT (Required)

Turn on to include VAT in the prices.
Start (Optional)

The date and time from which to retrieve prices. Defaults to today if omitted.
End (Optional)

The date and time until which to retrieve prices. Defaults to today if omitted.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as energyzero.get_energy_prices. Store the result in a response variable so you can use it in later steps:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more] 
action: energyzero.get_energy_prices
data:
  config_entry: YOUR_CONFIG_ENTRY_ID
  incl_vat: true
response_variable: energy_prices

This fetches today’s energy prices, including VAT.

Options in YAML

config_entry string Required

The EnergyZero config entry to use for this action.

incl_vat boolean Required, default: true

Turn on to include VAT in the prices.

start datetime

The date and time from which to retrieve prices. Defaults to today if omitted.

end datetime

The date and time until which to retrieve prices. Defaults to today if omitted.

Response data

The response contains a prices list. Each entry includes the following fields:

  • timestamp: The date and time the price applies to.
  • price: The energy price for that timestamp.

A shortened example of the response looks like this:

prices:
  - timestamp: "2023-09-25 03:00:00+00:00"
    price: 0.05
  - timestamp: "2023-09-25 04:00:00+00:00"
    price: 0.12

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one: