Automated budget tracking from Israeli financial institutions
Many people track their expenses with spreadsheets or with budgeting apps (like YNAB).
The most annoying part of this process is transferring the data from the banks or credit cards to the budgeting tool you use. It usually requires you to go to the website of each one of your banks and credit cards, and manually copy the data to your budgeting tool.
This project aims to automate this process by fetching the data automatically from your Israeli financial institutions and sending it to the budgeting tool of your choice.
In addition, it can automatically set an expense category for transactions according to predefined patterns.
Internally it uses the Israeli bank scrapers npm package.
If you want to ask questions, suggest features or report issues, join our discord channel.
We are in transition to a new UI. Some features don't yet exist in the new UI and will be added overtime. You can still access the old UI by clicking on the switch next to ממשק חדש.
Download the latest version from Releases page, or build it from source, with the instructions below. (Mac users, you may follow these instructions).
The first time you run the app, you will need to set up the accounts you want to fetch data from (importers).
Now you can set up the exporters - where the data will be sent to. The CSV exporter is enabled by default. If you want to export to YNAB, see instructions at the end of the README.
We are still in beta, and you may find errors. Please use the REPORT A PROBLEM button in the app to report to us.
Use this button to find the logs folder as well.
node-gyp
. In Windows you have a checkbox in the NodeJS installer to install also the node-gyp
.
This module is for packages that compile native code in their installation, in our case it is required for electron
and keytar
. (Note that if you install visual studio, you need to add the workload of desktop development with C++
)
Yarn.
Currently, this project depends on libsecret
, so you may need to install it before running yarn
.
Depending on your distribution, you will need to run the following command:
sudo apt-get install libsecret-1-dev
sudo yum install libsecret-devel
sudo pacman -S libsecret
For M1 macs, if you get an error while scraping due to not being able to download chromium, download it manually
as described here. Then in the settings,
set the chromium path to be the result of which chromium
yarn
to install the dependenciesyarn serve
to start the appRun
button in the appcategoryCalculationScript.js
. This file contains the patterns for classifying transactions to categories automatically.yarn build
YNAB is a budgeting software. If you want to manage your budget there and have your expenses updated automatically to YNAB follow these steps:
Account settings -> Developer settings
New Token
and generate
account number
could be the credit card number, or the bank account number. To be sure, you can run the app so it exports transactions to a CSV and get the account number from there.If you set Google Sheets as an exporter the transactions results will appear in a dedicated sheet. In the release version of Caspion, this integration will work out of the box. If you wish though to build/debug this from source, you will need to setup your own test OAuth 2.0 Client on GCP (Google Cloud Platform). Follow these steps:
http://localhost
http://127.0.0.1:42813/callback
and/or http://localhost:42813/callback
Client ID
& Client Secret
Now that you have the keys above, store them as env variables:
EXPORT GOOGLE_CLIENT_ID=XXXXX
EXPORT GOOGLE_CLIENT_SECRET=YYYYYY
That's it. Next time you'll run the code a one time OAuth authorization window will appear and ask for access.
In some cases you may get gibberish when you open the CSV file in Excel. In this case, please follow the next steps:
Data
-> Import From CSV/Text
.Unicode UTF-8 (65001)
.The Release workflow, configured in .github/workflows/release.yml
, will draft a new release or update the artifacts on an existing draft, according to the following conditions:
master
branch.version
from the package.json
, with the prefix v
, is not a published release.v${package_version}
Github Release.It means that after you published a new release, from the Github interface, you need to upgrade the version in the package.json
file, to get a new draft.
Providing your financial account credentials to software is not risk free. We will do our best to protect your credentials, but we take no responsibility for any possible damages. If you want to use this we suggest you ask your financial institution for credentials for a user that has only read access to the relevant account and use those credentials to reduce the potential risk.