2026.6.3
Home ▸ Actions

Get energy return prices

The Get energy return prices action fetches the prices for energy that you return (sell) from easyEnergy and returns them as response data.

This action does not target an entity. Instead, you select which easyEnergy configuration entry to use.

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 return 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 easyEnergy: Get energy return prices.
  6. Select the Config entry to use, and set any of the options you need.
  7. Select Save.

Options in the UI

Config entry (Required)

The easyEnergy configuration entry to use for this action.
Granularity (Optional)

The interval size for the electricity prices, either hourly or quarter-hourly.
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 easyenergy.get_energy_return_prices. A basic example looks like this:

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: easyenergy.get_energy_return_prices
data:
  config_entry: "013713c172577bada2874a32dbe44feb"
response_variable: return_prices

This fetches the return prices and stores them in the return_prices response variable.

Options in YAML

config_entry string Required

The easyEnergy configuration entry to use for this action.

granularity string

The interval size for the electricity prices. Use hour for hourly prices or quarter for quarter-hour 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 data is a mapping with a prices list. Each entry has a timestamp (string) and a price (number).

prices:
  - timestamp: "2023-12-09 03:00:00+00:00"
    price: 0.06957
  - timestamp: "2023-12-09 04:00:00+00:00"
    price: 0.07238

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: