redacted-crypto v1.0.2

Redacted-Crypto

About

Redacted-Crypto is a nice, simple, and clean NPM package that everyone can use. You can use it to track crypto currency trades from markets like binance.

Preview

Installation

Run the following command to install the npm package

npm i redacted-crypto

Usage

Basic Usage:

const RedactedCrypto = require('redacted-crypto');

let BTC = new RedactedCrypto.Watcher('BTCUSDT', 'BTC', 'USDT', 'binance');

BTC.on('trade', (trade) => {
    console.log(trade);
});

Advanced Usage:

const RedactedCrypto = require('redacted-crypto');

const port = 3000;
const debug = false;
const rateLimit = 10; // requests per second

let BTC = new RedactedCrypto.Watcher('BTCUSDT', 'BTC', 'USDT', 'binance');
let ETH = new RedactedCrypto.Watcher('ETHUSDT', 'ETH', 'USDT', 'binance');

// Starts Rest API
let client = new RedactedCrypto.Client([BTC, ETH], port, debug, ratelimit);

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT