Add sync-crypto.js for other cryptocurrencies besides just BTC (#31)

* add sync-crypto.js * update crypto payee name
2025-11-17 08:44:16 -07:00
parent c031e5bffd
commit b2a45903f9
2 changed files with 151 additions and 0 deletions
@@ -407,3 +407,43 @@ node sync-bitcoin.js
 ```

 It is recommended to run this script once per day or week.
+
+### Tracking Crypto Prices
+
+This script tracks the value of any cryptocurrency. Similar to the Bitcoin
+script, it adds new transactions to keep the account balance equal to the
+latest value. Values are retrieved from the Kraken API, but the script is
+customizable to use other APIs if needed.
+
+To use, set these tags in the account notes:
+
+- `CRYPTO:<symbol>,<symbol>,...` - where each symbol is a cryptocurrency
+  you want to track, e.g. `CRYPTO:BTC,ETH,DOGE`
+- `<symbol>:<amount>[,<krakenPair>]` - where `<symbol>` is the cryptocurrency
+  symbol and `<amount>` is the amount you own. If using Kraken, specify the Kraken
+  pair to use for the price. Obtain this by visiting
+  [https://api.kraken.com/0/public/Ticker?pair=<symbol\>usd](https://api.kraken.com/0/public/Ticker?pair=btcusd)
+  and locating the key under `result` that matches your symbol.
+
+For example, if you own 0.01 BTC and 1 ETH, your account note would look like:
+```
+CRYPTO:BTC,ETH
+BTC:0.01,XXBTZUSD
+ETH:1,XXETHZUSD
+```
+
+To use a different API, set the following in your `.env` file: (example using Bitcoin)
+```shell
+CRYPTO_PRICE_URL_BTC="https://api.kraken.com/0/public/Ticker?pair=xbtgbp"
+CRYPTO_PRICE_JSON_PATH_BTC="result.XXBTZGBP.c[0]"
+```
+
+To run:
+
+```console
+node sync-crypto.js
+```
+
+It is recommended to run this script once per day or week. If you are retrieving
+BTC prices using this script, DO NOT run the `sync-bitcoin.js` script as well, as it will
+set the account balance to the value of your BTC holdings only.