bitcharm-sdk v1.1.15

Bitcharm SDK for JavaScript

Introduction

Bitcharm SDK is developed based on TypeScript. By using Websocket to establish a connection, Please make sure that your client can support ES2015 version or higher.

Bitcharm SDK default support 10 times reconnection, but You can configure it using reconnectionTimes. If you want to close reconnection, please set reconnectionTimes to 0

Bitcharm SDK maintains a heartbeat after you create yourself, try to avoid disconnection.

Bitcharm SDK also have the ability to prevent duplicate subscription send messages, eliminating the need to consider the issue with a subscription channel will be repeated at the time you use, but only if the parameter is the same.

Currently, the Bitcharm SDK module that can be used are: Account, Chart, Quotes, Trade.

1. Account: Account Information Module;
2. Chart: Data and configuration required for drawing K-Line;
3. Quotes: Quotes Information Module;
4. Trade: It provides order placement and order modules;

Some interesting modules will continue to be added in the future, so stay tuned.

import {BitcharmSDK} from 'bitcharm-sdk';

const {modules: SDK} = BitcharmSDK({
    reconnectTimes: 15,
});

Installing

If you are sure to use the SDK, just install it like this.

npm install bitcharm-sdk

Example

After you successfully install the SDK, you can introduce him where you need to use it.

// The file name is dome.ts

import {SDK} from 'sdk';

const destroy = SDK.Quotes.orderBook("BTC-25DEC20", (message) => {
  // something...
});

// Please destroy it when you confirm that it is no longer in use
destroy();