starling-beancount 2.0.1

Import Starling Bank transactions in Beancount

starling-beancount

What is this

Use a Starling Developer account to programatically export your bank transactions to beancount files.

There are two main scripts:

1. starling_beancount/extractor.py converts Starling API JSON to beancount Transactions and Balances.
2. starling_beancount/importer.py contains the configuration for bean-extract to parse that.

Setup

Get a Starling Personal Access Token with the following scopes:

account:read
balance:read
transaction:read
space:read

Save the provided token text in a file somewhere useful (near your beancount files probably).

Install this library:

pip install starling-beancount smart_importer

Configuration

Make a copy of config.yml and edit it to suit your needs.

• The jointAccs and userIds fields are only needed if you have a joint account and you want to add metadata about which user made a transaction.

💪 Running the script

Then run the script:

Usage: starling [OPTIONS] ACC

Options:
  --fr TEXT
  --to TEXT                       [default: today]
  --balance / --no-balance        [default: no-balance]

Example to get the transactions from assets_starling (or whatever you called your token file) from a date until today:

starling assets_starling --fr=2021-01-01

Print the balance:

starling assets_starling --balance

🧠 As a beancount importer

You will need to add something like the following to your bean-extract configuration (eg config.py):

from starling_beancount.importer import StarlingImporter
from smart_importer import apply_hooks, PredictPostings
from smart_importer.detector import DuplicateDetector

CONFIG = [
    ...,
    apply_hooks(StarlingImporter(
        config_path="path/to/config.yml",
        acc="assets_starling",
        token_path="path/to/token.txt",
        bean_path="path/to/ledger.bean",
    ), [DuplicateDetector(), PredictPostings()])
]

Then add a Note to your ledger, specifying the earliest date you would like starling-beancount to extract from. It must have the text "bean-extract" somewhere in it. A new note will be added each time you run the script, so that you don't have to deal with too many duplicates.

2022-03-01 note Assets:Starling "bean-extract"

Last thing! You must create the "target" file that bean-extract will look for. Since we don't actually need a file (it all comes from the API), just add a file to wherever you would normally place them.

👉 Make sure to name this the same as the acc= argument to StarlingImporter above.

touch ./raw/assets_starling

So long as this file is there, bean-extract (and, by extension, the Fava importing tool) will find it and offer you to import that account.

Then run the following:

bean-extract config.py raw/assets_starling

Prior art

jorgeml/starlingbank does a similar thing, albeit more simply (probably for the better).