Skip to main content

A CLI tool that helps you rebalance your WealthSimple portfolios.

Project description

WealthSimple Portfolio Rebalancer

Build 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-2.0.0.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file ws_rebalancer-2.0.0.tar.gz.

File metadata

  • Download URL: ws_rebalancer-2.0.0.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ws_rebalancer-2.0.0.tar.gz
Algorithm Hash digest
SHA256 ce426658fd351bb85467724787c5218b2d346b4d503eb964b748b870127267db
MD5 b541134fea48826bc7e371da7f69c76a
BLAKE2b-256 d2629148df8824cd93c88ea763964684acafdb1faf463ca4a598fbdc6c5a3d8a

See more details on using hashes here.

Provenance

The following attestation bundles were made for ws_rebalancer-2.0.0.tar.gz:

Publisher: release.yml on EmilMaric/ws-rebalancer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: ws_rebalancer-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ws_rebalancer-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 695a92739c84b63feb9afb15b0682af2c196f51094c7b01e17402149b334dfe9
MD5 aa2b7cf2befa8601cb19e2be7e54ee7c
BLAKE2b-256 8d867bb0debeca68710101a056a1632dc75c0a23542ef5e2375a867c919096a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for ws_rebalancer-2.0.0-py3-none-any.whl:

Publisher: release.yml on EmilMaric/ws-rebalancer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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