# redacted-crypto

> ![](https://img.shields.io/github/stars/BlueFox-Development/Redacted-Crypto) ![](https://img.shields.io/github/forks/BlueFox-Development/Redacted-Crypto) ![](https://img.shields.io/github/issues/BlueFox-Development/Redacted-Crypto) ![](https://img.shields

Latest version **1.0.2** (published 2021-07-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install redacted-crypto
pnpm add redacted-crypto
yarn add redacted-crypto
bun add redacted-crypto
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-07-29 |
| First published | 2021-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 12.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | FlaringPhoenix |
| Maintainers | flaringphoenix |

## Links

- npm: https://www.npmjs.com/package/redacted-crypto
- Repository: https://github.com/BlueFox-Development/Redacted-Crypto
- Homepage: https://github.com/BlueFox-Development/Redacted-Crypto#readme
- Issues: https://github.com/BlueFox-Development/Redacted-Crypto/issues
- npm.io page: https://npm.io/package/redacted-crypto

## Dependencies (11)

- [cors](https://npm.io/package/cors.md) ^2.8.5
- [ccxws](https://npm.io/package/ccxws.md) ^0.43.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [dotenv](https://npm.io/package/dotenv.md) ^9.0.0
- [events](https://npm.io/package/events.md) ^3.3.0
- [helmet](https://npm.io/package/helmet.md) ^4.6.0
- [morgan](https://npm.io/package/morgan.md) ^1.10.0
- [express](https://npm.io/package/express.md) ^4.17.1
- [body-parser](https://npm.io/package/body-parser.md) ^1.19.0
- [liquidcache](https://npm.io/package/liquidcache.md) ^1.0.0
- [method-override](https://npm.io/package/method-override.md) ^3.0.0

## Recent versions

- 1.0.2 (latest) — 2021-07-29
- 1.0.1 — 2021-07-29
- 1.0.0 — 2021-07-29

## README

# Redacted-Crypto
![](https://img.shields.io/github/stars/BlueFox-Development/Redacted-Crypto) ![](https://img.shields.io/github/forks/BlueFox-Development/Redacted-Crypto) ![](https://img.shields.io/github/issues/BlueFox-Development/Redacted-Crypto) ![](https://img.shields.io/github/license/BlueFox-Development/Redacted-Crypto) ![](https://img.shields.io/discord/870418236078960791)

# 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

![Preview](https://i.gyazo.com/adcfd0e6d05e5cfb8645f3d083e91092.png)
![Preview](https://i.gyazo.com/8e0399230dc2d66f2bc54200d7f427b5.png)

# Installation

Run the following command to install the npm package

```bash
npm i redacted-crypto
```

## Usage

### Basic Usage:
```javascript
const RedactedCrypto = require('redacted-crypto');

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

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

### Advanced Usage:
```javascript
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);
```
# Support
Need some help setting up Redacted-Crypto, or have any questions or concerns? 
Join BlueFox Development's Discord
> [https://discord.gg/KHbBfWSdnZ](https://discord.gg/KHbBfWSdnZ)

## 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](https://choosealicense.com/licenses/mit/)

---
_Source: https://npm.io/package/redacted-crypto · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._