Giter VIP home page Giter VIP logo

sblaurock / crypticker Goto Github PK

View Code? Open in Web Editor NEW
65.0 5.0 8.0 480 KB

๐Ÿ“ˆ Simple command line cryptocurrency price ticker for Bitcoin, Ethereum, Litecoin, and more.

Home Page: https://www.npmjs.com/package/crypticker

License: MIT License

JavaScript 100.00%
bitcoin ethereum cryptowatch command-line coin ticker cryptocurrency cryptocurrency-price-ticker btc eth crypticker nodejs node crypto moon price-ticker dogecoin nft npm

crypticker's Introduction

crypticker

npm npm npm

Command line cryptocurrency price ticker for Bitcoin, Ethereum, and more.

screenshot

Installation / Update

Installation or update can be done via npm as a global package

npm i -g crypticker

Usage

Once installed globally, crypticker can be run as a binary

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 public API. A listing of supported markets can be found here. A forward slash (/) should be used to split pairs within markets list (for example: coinbase-pro:link/eth in favor of coinbase-pro:linketh).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.