UNPKG

cryptocom-api

Version:

EARLY BETA. Node.js connector for cryptocom's REST APIs and WebSockets, with TypeScript & end-to-end tests.

51 lines (33 loc) 2.28 kB
# cryptocom-api [![npm version](https://img.shields.io/npm/v/cryptocom-api)][1] [![npm size](https://img.shields.io/bundlephobia/min/cryptocom-api/latest)][1] [![npm downloads](https://img.shields.io/npm/dt/cryptocom-api)][1] [![last commit](https://img.shields.io/github/last-commit/tiagosiebler/cryptocom-api)][1] [![CodeFactor](https://www.codefactor.io/repository/github/tiagosiebler/cryptocom-api/badge)](https://www.codefactor.io/repository/github/tiagosiebler/cryptocom-api) [1]: https://www.npmjs.com/package/cryptocom-api WARNING: This package is still early beta, following the designs of my other connectors. If you want to stay informed when this may be ready for testing, please get in touch via telegram. Node.js connector for the cryptocom APIs and WebSockets, with TypeScript & browser support. ## Installation `npm install --save cryptocom-api` ## Issues & Discussion - Issues? Check the [issues tab](https://github.com/tiagosiebler/cryptocom-api/issues). - Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram. ## Related projects Check out my related JavaScript/TypeScript/Node.js projects: - Try my API & WebSocket SDKs: - [Bybit-api Node.js SDK](https://www.npmjs.com/package/bybit-api) - [Binance Node.js SDK](https://www.npmjs.com/package/binance) - [Okx-api Node.js SDK](https://www.npmjs.com/package/okx-api) - [Bitget-api Node.js SDK](https://www.npmjs.com/package/bitget-api) - [Bitmart-api Nodejs SDK](https://www.npmjs.com/package/bitmart-api) - Try my misc utilities: - [orderbooks node.js](https://www.npmjs.com/package/orderbooks) - [accountstate](https://www.npmjs.com/package/accountstate) - Check out my examples: - [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples) ## Structure This project uses typescript. Resources are stored in 3 key structures: - [src](./src) - the whole connector written in typescript - [dist](./dist) - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release. - [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome! --- # Usage TODO