Home Assistant

Starling Bank

The Starling Bank sensor platform allows you to monitor your account balance data as sensors in Home Assistant.

  • Turn off the lights when money’s tight?
  • Play a song when you reach a savings goal?
  • Sound an alarm if you go into your overdraft?

You can find more information about Starling Bank at their website. Information on their API can be found on their developers site.

Access Token

Once you have your own Starling bank account you will need to sign up for a Starling developer account here. You won’t need to do any development but you will need to get a “Personal Access Token” that will allow the integration to access your account balance.

You control what access is granted using this token. This integration only needs very basic access (see below).

Once you’ve signed up:

  1. Head to the Personal Access Section of your developer account.
  2. Click “Create Token”.
  3. Give your token a name e.g., “Home Assistant”.
  4. Tick the permissions “account:read” and “balance:read”. The others you can leave un-ticked.
  5. Click “Create” and make a note of the newly created token, you will need this for your Home Assistant configuration.

Configuration

To add Starling account balance sensors to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
sensor:
  - platform: starlingbank
    accounts:
      - access_token: YOUR_PERSONAL_ACCESS_TOKEN

Configuration Variables

Looking for your configuration file?
accounts list Required

A list of Starling accounts. Allows you to monitor multiple Starling accounts.

name string (Optional, default: Starling)

A friendly name for your account.

sandbox boolean (Optional, default: false)

For test purposes. Set to true if you are using an access token for a sandbox Starling account.

access_token string Required

Your personal access token.

balance_types list (Optional)

Choose to monitor your cleared or effective balance (or both).

Default:

Both balance types will be monitored.

cleared_balance

Excludes outstanding transactions.

effective_balance

Includes outstanding transactions.