Skip to content

Cryptocurrency Portfolio Manager: set your asset allocation, execute the auto rebalancer, chill

License

Notifications You must be signed in to change notification settings

ste316/calcWalletValue

Repository files navigation

Calculate Wallet Value is a program to instantly see how your cryptocurrency portfolio is performing.

Automatic portfolio Rebalancer is currently in beta phase and only support Kucoin exchange APIs.

If you want to try it switch to the Development Repo

  1. Prerequisites:

    • Download a python interpreter, suggested python version >= 3.9
    • Download all dependencies
      • move to the folder of the project
      • run: pip install -r requirements.txt
    • Insert all your assets and their amount in input.csv
    • Fill settings.json with your preferences
      • currency supported: "EUR" and "USD", needs to be uppercase

        • other currencies may be supported, have not been tested
      • 🟨🟨🟨NOTE: the first time you run the program make sure to fill fetchSymb with true 🟨🟨🟨

      • path field will be the parent folder where the data will be saved

      • provider can be "cg" for CoinGecko or "cmc" for CoinMarketCap

      • You can choose between CoinGecko and CoinMarketCap api

        • CoinGecko api is free and you do NOT need any api key, see plan and limits, Data provided by CoinGecko
        • CoinMarketCap it's free too, but you need to sign in and get an api key

        CoinMarketCap is lightning faster and easy to use, but you have less privacy.

        CoinGecko is slower and a bit more complicated to use, but you don't have to create any account or fill your information anywhere, yet more privacy.

        Both solutions are supported, make your choice.

        in case you choose CoinMarketCap, make sure to fill the api key in CMC_key field

    • After the first start-up all necessary files will be downloaded or writed
  2. Usage:

    • Preliminary step:

      • cd <folderOfProject>
    • You can run this command to:

      • 🟨🟨🟨NOTE: both command execute the same code, the only difference is the graphical output. So you will get your wallet data saved in your walletValue.json file anyway.🟨🟨🟨

      • instantly see your CRYPTO wallet:

        • python main.py --calc --crypto
        • you may want to obscure total value showed in the graphic, run python main.py --calc --crypto --privacy
        • you may want to see your portfolio in a past date(must have been calculated on that date), run python main.py --calc --crypto --load
      • crypto

      • instantly see your wallet splitted in CRYPTO and FIAT:

        • --calc --total
        • 🟨🟨🟨NOTE: stablecoins are counted as FIAT🟨🟨🟨
        • you may want to obscure total value showed in the graphic, run python main.py --calc --crypto --privacy
        • you may want to see your portfolio in a past date(must have been calculated on that date), run python main.py --calc --crypto --load
      • total

    • You can analyse your portfolio over time, using these commands:

      • 🟨🟨🟨NOTE: to run all this commands you need at least 2 records in walletValue.json🟨🟨🟨

      • Show your crypto wallet over time

        • python main.py --report --crypto
        • include stablecoins
      • Show your total wallet over time

        • python main.py --report --total
        • include all assets
      • Show fiat value and amout of an asset over time

        • python main.py --report --singleCrypto

About

Cryptocurrency Portfolio Manager: set your asset allocation, execute the auto rebalancer, chill

Topics

Resources

License

Stars

Watchers

Forks

Languages