Flick Electric

Flick Electric Co is a power company in New Zealand, based around a transparent pricing model where each component of pricing is provided. This integration uses the mobile app’s API from Flick Electric Co to get the current power price as well as each of the components price.

Configuration

To add the Flick Electric service to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Flick Electric.

  • Follow the instructions on screen to complete the setup.

Username

Username used to log into Flick Electric.

Password

Password used to log into Flick Electric.

Client ID

Client ID to authenticate (see below note).

Client Secret

Client Secret to authenticate (see below note).

Account

Address of the account to add (required when user has multiple active accounts).

Note

For most users, Client ID/Secret can be left blank.

Home Assistant by default uses the client ID and secret from the Flick Electric mobile app at the time of release.

If this stops working, you can find the new ones by using a MITM proxy with the mobile app. The app will call https://api.flick.energy/identity/oauth/token with the client_id and client_secret.

Supported functionality

The integration provides a sensor entity with the power price for the current time interval.

The attributes of the entity have a breakdown of the pricing components, such as generation and network charges.

Note

The power price shown is in cents, and is excluding GST. You can customize this by creating a template sensor:

  1. Go to Settings > Devices & Services > Helpers and click the add button;
  2. Choose the Template option
  3. Select Add a template sensor.

To add GST:

  • State template: {{ states.sensor.flick_power_price * 1.15 }}
  • Unit of measurement: ¢/kWh

To convert to dollars:

  • State template: {{ states.sensor.flick_power_price / 100 }}

  • Unit of measurement: $/kWh

Use cases

This integration can be used as part of an automation, for example to turn on/off appliances automatically.

Example automations

Turn off the heat pump when price is above 40¢/kWH
alias: "Turn off expensive heat pump"
description: "Turn off the heat pump when price is above 40¢/kWH"
triggers:
  - trigger: numeric_state
    entity_id: sensor.flick_power_price
    above: 40
actions:
  - action: climate.turn_off
    target:
      entity_id: climate.heat_pump
    data: {}

Data updates

The integration will pollData polling is the process of querying a device or service at regular intervals to check for updates or retrieve data. By defining a custom polling interval, you can control how frequently your system checks for new data, which can help optimize performance and reduce unnecessary network traffic. [Learn more] the Flick Electric API every 5 minutes to check for the current power price. You can also use the homeassistant.update_entity action to trigger a refresh on-demand.

Remove integration

This integration follows standard integration removal, no extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three-dot menu. Then, select Delete.

Troubleshooting

Cannot get pricing for this account. Please check user permissions

API is unable to find pricing for the selected account. Check with Flick Electric to ensure that your user is configured correctly.

No services are active on this Flick account

Only active accounts are supported by this integration. If your account is active but is not able to be selected, check with Flick Electric to ensure that it is showing as active in their system.