1.2.1 • Published 3 years ago
crypto-janitor v1.2.1
The Crypto Janitor
Takes the trash out of getting crypto account data
The Crypto Janitor provides a simple interface for
- Aggregating account transactions
- Getting USD values for transactions
Features
- Get transaction data from Bittrex, Coinbase, Coinbase Pro, and Kucoin via API keys
- Get transaction data from Nexo via CSV import
- Get transaction data from Ethereum Blockchain via address
Dependencies
This library makes use of the following packages:
- ccxt - Used to fetch data from exchange connections
- etherscan-api - Used to fetch data from Ethereum Blockchain
Installation
The Crypto Janitor requires Node.js v12+ to run.
Install The Crypto Janitor from npm
npm install crypto-janitorOr with yarn
yarn add crypto-janitorDocumentation
The Crypto Janitor API exposes
- Implemented connections (check em out)
- Connection base classes (so create your own connections!)
- Helper function to resolve and connection based on inputs
Implemented Connections
| Name | Type | Params |
|---|---|---|
| Bittrex | API | { apiKey, secret } |
| Coinbase | API | { apiKey, secret } |
| Coinbase Pro | API | { apiKey, secret, password } |
| Kucoin | API | { apiKey, secret, password } |
| Etherscan | Address | { address, apiKey } |
| Nexo | CSV | { fileName, loadFileContents } |
Base Connections
| Name | Type | Params |
|---|---|---|
| Base | any | { name, type, params } |
| CCXT | API | { name, credentials, params } |
| CSV | API | { name, fileName, loadFileContents } |
Helper Methods
| Name | Params |
|---|---|
| resolveConnection | { name, type, params } |
Development
Want to contribute? Great!
The Crypto Janitor is written in TypeScript and tested using jest. Make a sure all new features are tested before creating PR.
Build:
npm run buildRun tests:
npm run testLicense
MIT
Free Software, Hell Yeah!