- Gathers account balance from the Starling Bank API
- Open the directory for your HA configuration (where configuration.yaml is located)
- Open or create a custom_components directory
- Download all the files from the custom_components/hasslingbank/ directory (folder) in this repository.
- Place the files you downloaded into the custom_components directory
- Add "hasslingbank:" to your HA configuration (see examples below)
- Restart Home Assistant
Key | Type | Required | Default | Description |
---|---|---|---|---|
api_key | string | yes | None | Your Starling Bank API token |
name | string | no | sensor.starling | An optional custom name for the sensor |
hasslingbank:
api_key: <api_key>
Creating a Personal Access Token requires a Starling Bank Developer account. These are free and easy to setup.
- Log in to the Starling Developer website
- Open https://developer.starlingbank.com/personal/list
- Create a new token with the permissions:
- account:read
- balance:read
- Enter your password and click Generate
- Copy the token and paste it into the api_key entry in your configuration.yaml file