Skip to main content

A CLI tool that helps you rebalance your WealthSimple portfolios.

Project description

WealthSimple Portfolio Rebalancer

Build Status codecov

A CLI tool that helps you rebalance your WealthSimple portfolio. The tool takes in a CSV-file that contains the target allocations for your portfolio, and prints out a list of buys you should make to bring your portfolio closer to the target allocations you specified.

The tool will log you in to your WealthSimple account, where it will fetch your current positions & buying power, and will parse the CSV-file you defined to determine how far away each position is from the target allocation. It will then select the positions that are the farthest away from their target positions iteratively, until your buying power is used up.

Limitations

  • Currently the tool only supports doing buy-only rebalancing, meaning it won't try to simulate any sells in order to rebalance.
  • The tool only works with CAD denominated stocks and assumes your buying power is in CAD. If there is appetite for supporting other currencies then I can try to support that as well.
  • Prices for the stocks are fetched off the WealthSimple Trade API as well, so the quotes may be delayed by 15 minutes.

Installation

# To get the latest release
pip install ws-rebalancer

CSV-file requirements

To start, create a CSV file that will contain tickers from assets in your current portfolio, as well as tickers for any new assets you would like to add. In the CSV file, each line will represent a unique asset you own or want to own. On each line, you need to include the correct ticker for the asset and the target allocation for that asset. The format for each line is as follows:

<stock ticker>, <target allocation>

Here is a sample CSV file:

# sample-target-allocations.csv
MSFT, 50%
APPL, 30%
GOOG, 20%

In other words, I want my sample portfolio to be 50% Microsoft, 30% Apple, and 20% Google.

Make sure that the target allocations add up to 100%. The tool will raise an error and quit if that is not the case. You can also use decimals to represent fractional target allocations. Also don't repeat the same ticker twice. I've tried my best to sanitize the input and raise any errors that I can forsee with the CSV-file, but there may be some things that I didn't catch so please be careful.

Usage

To generate the buys that will rebalance your portfolio as close as possible to the target allocation, run the tool as follows:

$ ws-rebalancer rebalance -t <target-allocations-CSV-file> --email <WealthSimple-email-login> [--2fa]

Using our sample-target-allocations.csv as above, a sample run could look as follows:

$ ws-rebalancer rebalance -t sample-target-allocations.csv --email test@gmail.com --2fa
Password:
Repeat for confirmation:
Enter 2FA code: 12345
0. non-registered
Please input the account you want: 0
Buy 5X MSFT @ 10.00 - New allocation 40.00%
Buy 1X APPL @ 20.00 - New allocation 30.00%
Buy 1X GOOG @ 30.00 - New allocation 30.00%
Remaining cash $0.00

Note that in this example, MSFT price was $10.00, APPL price was $20.00, and GOOG price was $30.00, and we had a buying power of $60.00 in this account (although it is not shown). The tool also fetched our current positions and buying power for the specified account and then provided a list of buys we should make in order to try to meet the specified target allocations.

Finding Issues

If you find issues using this tool, please create an Issue using the Github issue tracker and I will try to address it as soon as I can.

Contributing

If you would like to contribute, please read the CONTRIBUTING.md page

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ws-rebalancer-1.0.1.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

ws_rebalancer-1.0.1-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file ws-rebalancer-1.0.1.tar.gz.

File metadata

  • Download URL: ws-rebalancer-1.0.1.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.1

File hashes

Hashes for ws-rebalancer-1.0.1.tar.gz
Algorithm Hash digest
SHA256 533d40c42c4d1f3a77dcc6de96d588f3a09b4200501b32ef337ec2b59960226f
MD5 a24323c52dcbc0b8383ef0b7baa0889e
BLAKE2b-256 6b5f3db740130a69d6df4c440f787d461bbc596739445451021d6bd0f490ff7f

See more details on using hashes here.

File details

Details for the file ws_rebalancer-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: ws_rebalancer-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.1

File hashes

Hashes for ws_rebalancer-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 44df7bdeadf6cad64c260ca4e72f0e1af711ca6cf33a5217fcb23c3a09f0f429
MD5 12d233ec1c3654f5cefefe622b8bc58e
BLAKE2b-256 446839bfa941441723d2d21d0f64bcbfe246ae2cacbd3c5aab084d3eaa54f481

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page