Skip to main content

A tool to automatically balance cryptocurrency portfolios

Project description

Build Status Coverage Status

Cryptocurrency Portfolio Balancer

USE AT YOUR OWN RISK. THIS TRADES REAL MONEY. NO WARRENTY IS GIVEN

A script that can connect to a cryptocurrency exchange and buy/sell cryptocurrency to keep your portfolio balancer to a certain ratio.

Install

$ virtualenv --python=python3 .
$ . bin/activate
$ pip install -r requirements.txt
$ pip install -e .

Config

Create a config file in config.ini with definition of your exchange and portfolio percentages, and theshold (percent) that rebalancing is needed:

[binance]
api_key = <api key>
api_secret = <api secret>
threshold = 2.0
targets = XRP 40
          BTC 20
	  ETH 20
	  BNB 10
	  USDT 10

By default it values the portfolio in USDT, this can be changed with --valuebase argument.

Running

Dry run (don't actually trade) against Binance

$ crypto_balancer binance
Connected to exchange: binance

Current Portfolio:
  XRP    3272.28  (39.92 / 40.00%)
  BTC    0.14     (20.05 / 20.00%)
  ETH    3.85     (20.02 / 20.00%)
  BNB    22.81    ( 9.99 / 10.00%)
  USDT   262.48   (10.02 / 10.00%)

  Total value: 2619.40 USDT
  Balance error: 0.043 / 0.08

No balancing needed

To force it to rebalance regardless of if needed:

$ crypto_balancer --force binance
Connected to exchange: binance

Current Portfolio:
  XRP    3272.28  (39.92 / 40.00%)
  BTC    0.14     (20.04 / 20.00%)
  ETH    3.85     (20.02 / 20.00%)
  BNB    22.81    ( 9.99 / 10.00%)
  USDT   262.48   (10.02 / 10.00%)

  Total value: 2619.28 USDT
  Balance error: 0.042 / 0.08

Balancing needed [FORCED]:

Proposed Portfolio:
  XRP    3278.51  (40.00 / 40.00%)
  BTC    0.14     (20.04 / 20.00%)
  ETH    3.83     (19.95 / 20.00%)
  BNB    22.81    ( 9.99 / 10.00%)
  USDT   262.48   (10.02 / 10.00%)

  Total value: 2619.28 USDT
  Balance error: 0.032
  Total fees to re-balance: 0.00199 USDT

Orders:
  BUY 6.2279674364331195 XRP/ETH @ 0.00234478

To get it to actually execute trades if needed:

$ crypto_balancer --force --trade binance
Connected to exchange: binance

Current Portfolio:
  XRP    3272.28  (39.96 / 40.00%)
  BTC    0.14     (20.04 / 20.00%)
  ETH    3.84     (19.94 / 20.00%)
  BNB    22.94    (10.04 / 10.00%)
  USDT   262.48   (10.02 / 10.00%)

  Total value: 2619.01 USDT
  Balance error: 0.043 / 0.08

Balancing needed [FORCED]:

Proposed Portfolio:
  XRP    3272.28  (39.96 / 40.00%)
  BTC    0.14     (20.04 / 20.00%)
  ETH    3.85     (20.00 / 20.00%)
  BNB    22.80    ( 9.98 / 10.00%)
  USDT   262.48   (10.02 / 10.00%)

  Total value: 2619.01 USDT
  Balance error: 0.031 / 0.08
  Total fees to re-balance: 0.001592 USDT

Orders:
  Submitted: sell 0.13 BNB/ETH @ 0.08422

Running automatically

You can set this to run in a cron job on a unix system by putting something along the lines of (adjust for your path and email address) below in your crontab file:

MAILTO=matt@example.com
*/5 * * * * OUTPUT=`cd /home/matt/crypto_balancer; bin/crypto_balancer --trade binance`; echo "$OUTPUT" | grep -q "No balancing needed" || echo "$OUTPUT"

This will run the script every 5 minutes, and will email you only if some balancing (or an error) occurs.

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

crypto_balancer-3.1.1.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

crypto_balancer-3.1.1-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file crypto_balancer-3.1.1.tar.gz.

File metadata

  • Download URL: crypto_balancer-3.1.1.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for crypto_balancer-3.1.1.tar.gz
Algorithm Hash digest
SHA256 e962b71714370bc0f117b22003d15fe61e40a60501d81d99c6d38f7c9185958b
MD5 addcedef1a014f60048ee71549dbd004
BLAKE2b-256 89a92bc2abd93a69814ad4e39a54ef2adc90fa6b15f0141a40904d6f42f38934

See more details on using hashes here.

File details

Details for the file crypto_balancer-3.1.1-py3-none-any.whl.

File metadata

  • Download URL: crypto_balancer-3.1.1-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for crypto_balancer-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2842c87dbc603d5f3b1cee28fbbd09a41945610850f17671dcb65749b9c153ee
MD5 c7cdd93bf7417175418a3675dd703280
BLAKE2b-256 b56b069b72d2cade82272eb2e5e5552b18c92b568f96a42169c5fb3e7b14f7a2

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