bankroll

Ingest portfolio and other data from multiple brokerages, and analyze it.

Table of contents:

1. Installation
2. Connecting to brokers
   1. Interactive Brokers
   2. Charles Schwab
   3. Fidelity
   4. Vanguard
3. Extending bankroll

Installation

To install bankroll as a Python package, simply run pip (or pip3, as it may be named on your system) from the repository root:

pip install .

This will also make the command-line tool available directly:

bankroll --help

The Interactive Brokers API must also be installed prior to using bankroll. This repository includes a helpful script to ease this process:

script/install_twsapi

If you do not want to install ibapi globally, you may wish to set up a Python virtual environment instead.

Connecting to brokers

After being set up, bankroll can be used from the command line to bring together data from multiple brokerages.

For example, to show all positions held in both Interactive Brokers and Charles Schwab:

python -m bankroll \
  --twsport 7496 \
  --schwabpositions ~/Positions-2019-01-01.CSV \
  --schwabtransactions ~/Transactions_20190101.CSV \
  positions

Run with --help to see all options:

python -m bankroll --help

Interactive Brokers

Interactive Brokers (sometimes abbreviated as IB or IBKR) offers a well-supported API, which—along with ib_insync—makes it possible to load up-to-date portfolio data and request real-time information about particular securities.

Because this integration is so useful, some generic functionality in bankroll will require an IB account.

Unfortunately, one of IB's trading applications—Trader Workstation or IB Gateway—must be running and logged-in to accept API connections. You may wish to use IBC to automate the startup and login of these applications.

Once Trader Workstation or IB Gateway is running, and API connections are enabled, provide the local port number to bankroll like so:

python -m bankroll \
  --twsport 7496 \
  [command]

Querying trade history

IB's Trader Workstation API does not support retrieving information about an account's historical trades, so bankroll must use their Flex Web Service.

To set this up, log in to Account Management, then browse to Settings → Account Settings in the sidebar:

In the Reporting section of this page, click the gear to configure Flex Web Service:

Once configured, copy the Current Token for use on the command line.

Then, you must save a query for bankroll to use. Back in the sidebar, browse to Reports → Flex Queries:

Click the gear to configure Custom Flex Queries:

Create a new Trade Confirmation Flex Query Template:

Pick a name of your choosing, then make sure the Date Period reflects the historical period you care about (e.g., Last 365 Calendar Days):

Under Sections, click Trade Confirmations and enable everything in the dialog which appears:

After saving your query, expand it in the list to view and copy the Query ID for use on the command line.

With the token and the query ID from your account, historical trades can be downloaded:

python -m bankroll \
  --flextoken [token] \
  --flexquery-trades [query ID] \
  activity

Querying dividend history

This workflow will be simplified in the future.

To incorporate the history of dividend payments in your portfolio, follow the same steps for the Trade Confirmation Flex Query, but create an Activity Flex Query instead.

The only section which needs to be enabled is Change in Dividend Accruals:

Pass your existing token, and the new query's ID, on the command line:

python -m bankroll \
  --flextoken [token] \
  --flexquery-activity [query ID] \
  activity

Charles Schwab

Charles Schwab does not offer an API, but it does provide CSV files for export, which bankroll can then import.

Browse to the "Positions" and/or "Transactions" screen:

Click the "Export" link in the top-right:

Then provide the paths of either or both these downloaded files to bankroll:

python -m bankroll \
  --schwabpositions ~/path/to/Positions.CSV \
  --schwabtransactions ~/path/to/Transactions.CSV \
  [command]

Fidelity

Fidelity is supported through a similar facility as Schwab. More detailed instructions have yet to be written—contributions welcome!

Vanguard

Vanguard is a work in progress, and may not be as fully-featured as the other brokerages listed here. Contributions welcome!

Extending bankroll

Although the command-line interface exposes a basic set of functionality, it will never be able to capture the full set of possible use cases. For much greater flexibility, you can write Python code to use bankroll directly, and build on top of its APIs for your own purposes.

For some examples, see the included notebooks.