Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paulrberg/cryptfolio-scripts
A collection of Google Apps Script custom functions for tracking crypto portfolios in Google Sheets
https://github.com/paulrberg/cryptfolio-scripts
crypto cryptocurrency google-apps-script google-sheets portfolio spreadsheet
Last synced: 3 months ago
JSON representation
A collection of Google Apps Script custom functions for tracking crypto portfolios in Google Sheets
- Host: GitHub
- URL: https://github.com/paulrberg/cryptfolio-scripts
- Owner: PaulRBerg
- License: mit
- Created: 2024-01-21T18:01:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-03T16:44:16.000Z (7 months ago)
- Last Synced: 2024-10-08T02:22:23.589Z (4 months ago)
- Topics: crypto, cryptocurrency, google-apps-script, google-sheets, portfolio, spreadsheet
- Language: JavaScript
- Homepage:
- Size: 129 KB
- Stars: 20
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Cryptfolio Scripts
A collection of Google Apps Script custom functions for tracking crypto portfolios in Google Sheets.
The price data is pulled using [CoinGecko's API](https://www.coingecko.com/en/api), and the token balances are obtained
by making queries to various RPC servers like [PublicNode](https://publicnode.com/).
_If this project helped you, consider buying me a coffee via [3Cities][3cities] or [GitHub Sponsors][sponsors]_.
## How to Use
1. Obtain a CoinGecko Demo API by following the instructions
[here](https://support.coingecko.com/hc/en-us/articles/21880397454233-User-Guide-How-to-sign-up-for-CoinGecko-Demo-API-and-generate-an-API-key).
2. Open the [Cryptfolio template][template] in Google Sheets.
3. Click on "File", and then "Make a copy". This will create a copy of the template in Google Sheets.
4. From the toolbar, click on "Extensions", and then on "Apps Script". You should be able to see the code now.
5. Add the chains and tokens you want to track in the `chainIDs` and `tokenData` variables.
6. Query the price data by running the `GET_ALL_PRICES` function.
7. Use the `GET_ERC20_BALANCE` and `GET_NATIVE_BALANCE` functions to query your holdings in real-time.
8. Calculate the USD value of your holdings by reading the local price data with `INDEX` and `MATCH`.
> [!NOTE]
>
> The `GET_ALL_PRICES` can only be run from within Apps Script. See the [Custom Functions](#custom-functions) section
> below.
## Template
The [template][template] shows how to query balances for ARB, ETH, MKR, and OP, and how to calculate the values of the
holdings:
## Rationale
I built this because I was frustrated with the existing solutions, which are either too complex, too expensive, or too
unstable.
Cryptfolio is:
- Free to use
- Minimalist
- DYI and easy to customize
- Functional; it just works
## Customization
This project is meant to be forked and customized to your needs. Here are two common use cases:
### Chains
To track a new chain:
- Add it in the `Chains` sheet in the spreadsheet.
- Edit `chainIds` in [`cryptfolio.gs`](./src/cryptfolio.gs).
### Tokens
To track a new token:
- List it in the `Prices` sheet in the spreadsheet. Ensure that the `CRYPTO_IDS` range got updated, too.
- Edit the `tokenData` object in [`cryptfolio.gs`](./src/cryptfolio.gs).
## Custom Functions
Here's a table with the custom functions enabled by this project.
The Read functions can be called from either Google Sheets or Apps Script, but the Write functions can only be run from
within the Apps Script environment. This is because a
[custom function](https://developers.google.com/apps-script/guides/sheets/functions?hl=en) cannot affect cells other
than those it returns a value to.
| Function | Type | Params | Description |
| ------------------------ | ----- | ------------------------ | ---------------------------------------------------------------------------- |
| `GET_ERC20_BALANCE` | Read | (chainID,symbol,account) | Get the ERC-20 token balance of `account` on the chain with ID `chainID` |
| `GET_EVM_NATIVE_BALANCE` | Read | (chainID,account) | Get the EVM native asset balance of `account` on the chain with ID `chainID` |
| `GET_ALL_PRICES` | Write | (fiat) | Get the current `fiat` prices for all `CRYPTO_IDS` |
| `GET_PRICE` | Write | (crypto,fiat) | Get the current `fiat` price for `crypto` |
## Contributing
Feel free to dive in! [Open](https://github.com/PaulRBerg/cryptfolio-scripts/issues/new) an issue,
[start](https://github.com/PaulRBerg/cryptfolio-scripts/discussions/new) a discussion or submit a PR.
## CoinGecko
This project couldn't exist without the [CoinGecko API](https://www.coingecko.com/en/api). Thank you for providing such
a valuable service for free!
## License
This project is licensed under MIT.
[3cities]: https://3cities.xyz/#/pay?c=CAESFAKY9DMuOFdjE4Wzl2YyUFipPiSfIgICATICCAJaFURvbmF0aW9uIHRvIFBhdWwgQmVyZw
[sponsors]: https://github.com/sponsors/PaulRBerg
[template]: https://docs.google.com/spreadsheets/d/1V3uIiz5BxVd1ZBRh1s3thso5mW74tHATqcGovox2FlU/edit?usp=sharing