home-assistant.io/source/_components/starlingbank.markdown
Franck Nijhof c464056402
Making our website faster, cleaner and prettier (#9853)
* 🔥 Removes octopress.js

* 🔥 Removes use of root_url var

* 🔥 Removes Octopress generator reference from feed

* 🔥 Removes delicious support

* 🔥 Removes support for Pinboard

* 🔥 Removes support for Disqus

* 🔥 Removes support for Google Plus

* ↩️ Migrate custom after_footer to default template

* ↩️ Migrate custom footer to default template

* ↩️ Migrate custom header to default template

* 🔥 Removes unused template files

* 🚀 Places time to read directly in post template

* 🚀 Removes unneeded capture from archive_post.html template

* 🔥 🚀 Removes unused, but heaving sorting call in component page

* 🚀 Merged javascripts into a single file

* 🔥 Removes more uses of root_url

* 🚀 Removal of unneeded captures from head

* 🔥 🚀 Removal of expensive liquid HTML compressor

* 🔥 Removes unneeded templates

* 🚀 Replaces kramdown with GitHub's CommonMark 🚀

* 💄 Adds Prism code syntax highlighting

*  Adds support for redirect in Netlify

* ↩️ 🔥 Let Netlify handle all developer doc redirects

* ✏️ Fixes typo in redirects file: Netify -> Netlify

* 🔥 Removes unused .themes folder

* 🔥 Removes unused aside.html template

* 🔥 Removes Disqus config leftover

* 🔥 Removes rouge highlighter config

* 🔥 Removes Octopress 🎉

* 💄 Adjust code block font size and adds soft wraps

* 💄 Adds styling for inline code blocks

* 💄 Improve styling of note/warning/info boxes + div support

* 🔨 Rewrites all note/warning/info boxes
2019-07-15 22:17:54 +02:00

2.7 KiB

title, description, logo, ha_category, ha_release, ha_iot_class, redirect_from
title description logo ha_category ha_release ha_iot_class redirect_from
Starling Bank How to integrate your Starling Bank account within Home Assistant. starlingbank.png
Finance
0.79 Cloud Polling
/components/sensor.starlingbank/

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 %} accounts: description: A list of Starling accounts. Allows you to monitor multiple Starling accounts. required: true type: list name: description: A friendly name for your account. required: false type: string default: Starling sandbox: description: For test purposes. Set to true if you are using an access token for a sandbox Starling account. required: false default: false type: boolean access_token: description: Your personal access token. required: true type: string balance_types: description: Choose to monitor your cleared or effective balance (or both). required: false type: list default: Both balance types will be monitored. keys: cleared_balance: description: Excludes outstanding transactions. effective_balance: description: Includes outstanding transactions. {% endconfiguration %}