Nordigen Home Assistant integration

This integration will allow you to have access to banking data for most banks in the EU.

Installation

HACS coming soon!

You will need to register on Nordigen and get an API key before you can run this integration. At this time there is only support for one API key per HA instance.

Installation

1. Copy / clone this integration into ./config/custom_components/nordigen
2. Restart Home Assistant to get the integration loaded

Configuraiton

1. Add your config to ./config/configuration.yaml or similar
2. Validate the config using UI or CLI.
3. Restart Home Assistant

Authentication

1. Check the developer section for sensors, there should be a sensor with the account number / reference containing a link to authenticate your account.
2. Click the link and follow the instructions
3. Restart Home Assistant one last time

In the future I hope to be able to make the system a bit more dynamic and user friendly for account onboarding :)

Configuration

This integration pairs a "user id" with a banking institution. Each banking institution will return one or more accounts, each of which can have multiple types of balances.

Each requisition can contain the following options:

Example Config

Assuming you bank with a single institution, your config may look like this.

nordigen:
  token: !secret nordigen
  requisitions:
    - enduser_id: user-id-1
      aspsp_id: BANK_A

Should you have more than one institution you use (credit cards are often apart from current acounts)

nordigen:
  token: !secret nordigen
  requisitions:
    - enduser_id: user-id-1
      aspsp_id: BANK_A
    - enduser_id: user-id-1
      aspsp_id: BANK_B

Multiple users with the same institution, but ignoring an account

nordigen:
  token: !secret nordigen
  requisitions:
    - enduser_id: user-id-1
      aspsp_id: BANK_A
    - enduser_id: user-id-2
      aspsp_id: BANK_A
      ignore_accounts:
        - ACCOUNT_ID_1234

Derivative Sensors

You can build derivative sensors to view your total wealth for example

sensor:
  - platform: template
    sensors:
      my_wealth:
        unit_of_measurement: SEK
        value_template: |
          {{
            (
              (states('sensor.account_123_available') | float) +
              (states('sensor.account_456_available') | float) +
              (states('sensor.account_789_available') | float) +
            ) | round(2)
          }}

Automations

Turn off your outside lights when your account balance is getting low.

automation:
  - alias: "broke"
    trigger:
      - platform: numeric_state
          entity_id: sensor.account_123_available
          below: 2500
    action:
    - service: light.turn_off
        target:
        entity_id: light.exterior_lighting

Technical details

I wanted to have good test coverage and could not find a good way to do it within this integration so I've abstracted out all the code into a standalone python lib.

That in turn uses a generic API [clinet lib] for Nordigen

About Nordigen

Nordigen is an all-in-one banking data API for building powerful banking, lending and finance apps. They offer a free API for fetching account info, balances and transactions. They also handle all the authentication between the banks and do a little bit of data nomilisation.

Check out the Nordigen API for full details.