xchange-js
v0.0.9
Published
Interface to access crypto exchange data
Downloads
27
Readme
xchange-js
Currently under development. Use at your own risk.
A basic node library providing a simple and consistent API to interact with various cryptocurrency exchanges. Provides support for both REST and Websocket APIs.
Installation
npm install --save xchange-js
Wiki
Documentation and instructions under project wiki.
TODO
- ~~Public: Trade API~~
- ~~Public: Symbols API~~
- ~~Public: Ticker API~~
- ~~Websocket: Orderbook~~
- Add tests
- ~~Public: Order Book API~~
- Private: Account API
- Private: Trading API
- Websocket: Ticker
- Websocket: Trades
- Refactor WebsocketClient and Orderbook for Reausability
- Implement Other Exchanges
License
The MIT License (MIT)
Copyright (c) 2017 Connor Giles [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.