https://github.com/sblaurock/crypticker
📈 Simple command line cryptocurrency price ticker for Bitcoin, Ethereum, Litecoin, and more.
https://github.com/sblaurock/crypticker
bitcoin btc coin command-line crypticker crypto cryptocurrency cryptocurrency-price-ticker cryptowatch dogecoin eth ethereum moon nft node nodejs npm price-ticker ticker
Last synced: 4 months ago
JSON representation
📈 Simple command line cryptocurrency price ticker for Bitcoin, Ethereum, Litecoin, and more.
- Host: GitHub
- URL: https://github.com/sblaurock/crypticker
- Owner: sblaurock
- License: mit
- Created: 2017-05-04T03:02:16.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T03:53:24.000Z (over 1 year ago)
- Last Synced: 2025-10-04T09:41:41.446Z (8 months ago)
- Topics: bitcoin, btc, coin, command-line, crypticker, crypto, cryptocurrency, cryptocurrency-price-ticker, cryptowatch, dogecoin, eth, ethereum, moon, nft, node, nodejs, npm, price-ticker, ticker
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/crypticker
- Size: 244 KB
- Stars: 69
- Watchers: 4
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# crypticker
[](https://www.npmjs.com/package/crypticker)
[](https://www.npmjs.com/package/crypticker)
[](https://www.npmjs.com/package/crypticker)
> [!WARNING]
> **This project is no longer actively maintained and the application is not functional**, as the [Cryptowatch API has been sunset](https://blog.kraken.com/product/cryptowatch-to-sunset-kraken-pro-to-integrate-cryptowatch-features).
---
Command line cryptocurrency price ticker for Bitcoin, Ethereum, and more.
### Installation / Update
Installation or update can be done via `npm` as a global package
```bash
npm i -g crypticker
```
### Usage
Once installed globally, `crypticker` can be run as a binary
```bash
crypticker
```
| Flag | Type | Description |
| --- | --- | --- |
| `--no-history` | | Disable history display |
| `--interval` | Integer | Poll interval in milliseconds |
| `--markets` | String | Comma separated list of markets |
| `--api-key` | String | Cryptowat.ch API key (optional) |
### Options
Markets and application preferences can be managed within `options.json`. If the package was installed globally, the installation directory (and corresponding `options.json`) file may be found with `npm root -g`. Application will prefer an options file named `.crypticker` located in the home directory (`~`) if one exists - this can be used to preserve options between updates.
`cp $(npm root -g)/crypticker/options.json ~/.crypticker` may be used to create a local copy of the options file.
| Parameter | Type | Description | Example |
| --- | --- | --- | --- |
| apiKey | String | Cryptowat.ch API key (optional) | `BYKU2QBYIQUE386W37BO` |
| pollInterval | Integer | Interval at which to poll API (in milliseconds) | `30000` |
| padding | Integer | Number of spaces to use between display sections | `8` |
| history | Object | Parameters around ticker history display | |
| history.enabled | Boolean | Toggles history display on and off | `true` |
| history.length | Integer | Number of ticks to display within readout | `16` |
| history.hideAmount | Boolean | Toggles display of price changes on and off | `false` |
| history.minorThreshold | Float | Change percentage that must be exceeded to display a minor symbol | `0.00` |
| history.majorThreshold | Float | Change percentage that must be exceeded to display a major symbol | `0.20` |
| history.positiveMajorSymbol | String | Symbol to use for positive major trend | `"∙"` |
| history.positiveMinorSymbol | String | Symbol to use for positive minor trend | `"â‹…"` |
| history.neutralSymbol | String | Symbol to use for no trend | `"â‹…"` |
| history.negativeMinorSymbol | String | Symbol to use for negative minor trend | `"â‹…"` |
| history.negativeMajorSymbol | String | Symbol to use for negative major trend | `"∙"` |
| markets | Array | List of markets to monitor | `['coinbase-pro:eth/btc']` |
Powered by the [Cryptowatch](https://cryptowat.ch/docs/api) public API. A listing of supported markets can be found [here](https://api.cryptowat.ch/markets). A forward slash (`/`) should be used to split pairs within markets list (for example: `coinbase-pro:link/eth` in favor of `coinbase-pro:linketh`).