kucoin-api 0.0.3 → 1.0.1

package/README.md

@@ -1,886 +1,277 @@
-<p align="center">
-  <img
-    src="https://user-images.githubusercontent.com/30309816/31295829-c8d25310-ab2b-11e7-8885-fb335d0c3baf.png"
-    width="125px;">
-</p>
-
-<h1 align="center">KuCoin API Client</h1>
+# Node.js & JavaScript SDK for Kucoin REST APIs, WebSockets & WebSocket API
 
 <p align="center">
-  A Node.js client for the [KuCoin](https://www.kucoin.com/) API.
+  <a href="https://www.npmjs.com/package/kucoin-api">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/tiagosiebler/kucoin-api/blob/master/docs/images/logoDarkMode2.svg?raw=true#gh-dark-mode-only">
+      <img alt="SDK Logo" src="https://github.com/tiagosiebler/kucoin-api/blob/master/docs/images/logoBrightMode2.svg?raw=true#gh-light-mode-only">
+    </picture>
+  </a>
 </p>
 
-## Overview
-
-### What does it currently do
-
-The [KuCoin API documentation](http://docs.kucoinapidocs.apiary.io/) is not too bad, though some holes and inconsistencies. This Node.js client attempts to make up for some of those. 25 of the 29 endpoints are supported, the missing ones are mainly relating to Kline data.
-
-### Get help or give help
-
--   Open a new [issue](https://github.com/Satoshinaire/kucoin-api/issues/new) if you encounter a problem.
--   Or ping **@satoshinaire** on **Twitter**.
--   Pull requests welcome.
-
-## Getting started
-
-### Installation
-
-    npm install --save kucoin-api
-
-### Usage
-
-    'use strict'
-
-    require('dotenv').config()
-    const Kucoin = require('kucoin-api')
-
-    let kc = new Kucoin(process.env.KUCOIN_API_KEY, process.env.KUCOIN_API_SECRET)
+[![npm version](https://img.shields.io/npm/v/kucoin-api)][1]
+[![npm size](https://img.shields.io/bundlephobia/min/kucoin-api/latest)][1]
+[![npm downloads](https://img.shields.io/npm/dt/kucoin-api)][1]
+[![Build & Test](https://github.com/tiagosiebler/kucoin-api/actions/workflows/e2etest.yml/badge.svg?branch=master)](https://github.com/tiagosiebler/kucoin-api/actions/workflows/e2etest.yml)
+[![last commit](https://img.shields.io/github/last-commit/tiagosiebler/kucoin-api)][1]
+[![Telegram](https://img.shields.io/badge/chat-on%20telegram-blue.svg)](https://t.me/nodetraders)
 
-    kc.getBalance({
-        symbol: 'GAS'
-      })
-      .then((result) => {
-        console.log(result)
-      })
-      .catch((err) => {
-        console.log(err)
-      })
+[1]: https://www.npmjs.com/package/kucoin-api
 
-## API
+Updated & performant JavaScript & Node.js SDK for the Kucoin REST APIs and WebSockets:
 
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+- Complete integration with all Kucoin REST APIs and WebSockets.
+- TypeScript support (with type declarations for most API requests & responses)
+- Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
+- Browser-friendly HMAC signature mechanism.
+- Automatically supports both ESM and CJS projects.
+- Proxy support via axios integration.
+- Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
 
-### Kucoin
+## Installation
 
-A Node.js client for the KuCoin API.
+`npm install --save kucoin-api`
 
-**Parameters**
+## Issues & Discussion
 
--   `apiKey` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Your KuCoin API Key.
--   `apiSecret` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Your KuCoin API Secret.
+- Issues? Check the [issues tab](https://github.com/tiagosiebler/kucoin-api/issues).
+- Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram.
 
-**Examples**
+<!-- template_related_projects -->
 
-```javascript
-let kc = new Kucoin();
-```
+## Related projects
 
-**Meta**
+Check out my related JavaScript/TypeScript/Node.js projects:
 
--   **version**: 0.0.2
+- Try my REST API & WebSocket SDKs:
+  - [Bybit-api Node.js SDK](https://www.npmjs.com/package/bybit-api)
+  - [Okx-api Node.js SDK](https://www.npmjs.com/package/okx-api)
+  - [Binance Node.js SDK](https://www.npmjs.com/package/binance)
+  - [Gateio-api Node.js SDK](https://www.npmjs.com/package/gateio-api)
+  - [Bitget-api Node.js SDK](https://www.npmjs.com/package/bitget-api)
+  - [Bitmart-api Node.js SDK](https://www.npmjs.com/package/bitmart-api)
+- Try my misc utilities:
+  - [OrderBooks Node.js](https://www.npmjs.com/package/orderbooks)
+  - [Crypto Exchange Account State Cache](https://www.npmjs.com/package/accountstate)
+- Check out my examples:
+  - [awesome-crypto-examples Node.js](https://github.com/tiagosiebler/awesome-crypto-examples)
+  <!-- template_related_projects_end -->
 
-#### getExchangeRates
+## Documentation
 
-Retrieve exchange rates for coins.
+Most methods accept JS objects. These can be populated using parameters specified by Kucoin's API documentation.
 
-**Parameters**
+- [Kucoin API Documentation](https://www.kucoin.com/docs/beginners/introduction)
+- Node.js Quick Start Guides
+  - [Spot Node.js Kucoin Quick Start Guide](./examples/kucoin-SPOT-examples-nodejs.md)
+  - [Futures Node.js Kucoin Quick Start Guide](./examples/kucoin-FUTURES-examples-nodejs.md)
+- [Futures Node.js Kucoin Order Placement Guide](./examples/rest-futures-orders-guide.ts)
+<!-- - [TSDoc Documentation (autogenerated using typedoc)](https://tsdocs.dev/docs/kucoin-api) -->
 
--   `params` **{symbols: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>}?** An Array of symbols, or if blank BTC will be returned. (optional, default `{}`)
+## Structure
 
-**Examples**
+This project uses typescript. Resources are stored in 2 key structures:
 
-_Specify one or more symbols:_
-
-```javascript
-kc.getExchangeRates({
-  symbols: ['NEO','GAS']
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509589905631,
-  "data": {
-    "currencies": [["USD", "$"], ["EUR", "€"], ["AUD", "$"], ["CAD", "$"], ["CHF", "CHF"], ["CNY", "¥"], ["GBP", "£"], ["JPY", "¥"], ["NZD", "$"], ["BGN", "лв."], ["BRL", "R$"], ["CZK", "Kč"], ["DKK", "kr"], ["HKD", "$"], ["HRK", "kn"], ["HUF", "Ft"], ["IDR", "Rp"], ["ILS", "₪"], ["INR", "₹"], ["KRW", "₩"], ["MXN", "$"], ["MYR", "RM"], ["NOK", "kr"], ["PHP", "₱"], ["PLN", "zł"], ["RON", "lei"], ["RUB", "₽"], ["SEK", "kr"], ["SGD", "$"], ["THB", "฿"], ["TRY", "₺"], ["ZAR", "R"]],
-    "rates": {
-      "GAS": { "CHF": 14.57, "HRK": 94.19, "MXN": 279.02, "ZAR": 205.31, "INR": 939.59, "CNY": 96.15, "THB": 482.3, "AUD": 18.95, "ILS": 51.16, "KRW": 16176.81, "JPY": 1660.88, "PLN": 53.03, "GBP": 10.94, "IDR": 197577.69, "HUF": 3904.86, "PHP": 751.63, "TRY": 55.6, "RUB": 845.61, "HKD": 113.47, "EUR": 12.52, "DKK": 93.21, "USD": 14.54, "CAD": 18.77, "MYR": 61.54, "BGN": 24.49, "NOK": 118.5, "RON": 57.66, "SGD": 19.8, "CZK": 320.11, "SEK": 122.16, "NZD": 21.12, "BRL": 47.78
-      },
-      "NEO": {
-        "CHF": 25.33, "HRK": 163.66, "MXN": 484.81, "ZAR": 356.73, "INR": 1632.55, "CNY": 167.07, "THB": 838.01, "AUD": 32.94, "ILS": 88.89, "KRW": 28107.31, "JPY": 2885.78, "PLN": 92.14, "GBP": 19.01, "IDR": 343292.4, "HUF": 6784.72, "PHP": 1305.97, "TRY": 96.61, "RUB": 1469.25, "HKD": 197.16, "EUR": 21.76, "DKK": 161.95, "USD": 25.27, "CAD": 32.61, "MYR": 106.93, "BGN": 42.56, "NOK": 205.9, "RON": 100.18, "SGD": 34.4, "CZK": 556.2, "SEK": 212.27, "NZD": 36.7, "BRL": 83.02
-      }
-    }
-  }
-}
-```
+- [src](./src) - the whole connector written in typescript
+- [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome!
 
-_Retrieve data for BTC by default:_
+---
 
-```javascript
-kc.getExchangeRates().then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509590207497,
-  "data": {
-    "rates": {
-      "BTC": { "CHF": 6817.62, "HRK": 44045.89, "MXN": 130476.13, "ZAR": 96007.15, "INR": 439363.98, "CNY": 44963.39, "THB": 225531.1, "AUD": 8865.49, "ILS": 23923.57, "KRW": 7564405.86, "JPY": 776640.44, "PLN": 24798.21, "GBP": 5118.25, "IDR": 92388859.2, "HUF": 1825945.01, "PHP": 351470.78, "TRY": 26002.05, "RUB": 395413.97, "HKD": 53061.7, "EUR": 5857.14, "DKK": 43586.13, "USD": 6801.3, "CAD": 8777.75, "MYR": 28779.7, "BGN": 11455.42, "NOK": 55414.27, "RON": 26962.39, "SGD": 9259.28, "CZK": 149689.81, "SEK": 57127.51, "NZD": 9878.88, "BRL": 22344.99
-      }
-    },
-    "currencies": [["USD", "$"], ["EUR", "€"], ["AUD", "$"], ["CAD", "$"], ["CHF", "CHF"], ["CNY", "¥"], ["GBP", "£"], ["JPY", "¥"], ["NZD", "$"], ["BGN", "лв."], ["BRL", "R$"], ["CZK", "Kč"], ["DKK", "kr"], ["HKD", "$"], ["HRK", "kn"], ["HUF", "Ft"], ["IDR", "Rp"], ["ILS", "₪"], ["INR", "₹"], ["KRW", "₩"], ["MXN", "$"], ["MYR", "RM"], ["NOK", "kr"], ["PHP", "₱"], ["PLN", "zł"], ["RON", "lei"], ["RUB", "₽"], ["SEK", "kr"], ["SGD", "$"], ["THB", "฿"], ["TRY", "₺"], ["ZAR", "R"]]
-  }
-}
-```
+# Usage
 
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
+Create API credentials
 
-#### getLanguages
+- [Kucoin API Key Management](https://www.kucoin.com/account/api)
 
-Retrieve a list of supported languages.
+### REST API
 
-**Examples**
+To use any of Kucoin's REST APIs in JavaScript/TypeScript/Node.js, import (or require) the `SpotClient` (for spot and margin APIs) or `FuturesClient` (for futures APIs):
 
 ```javascript
-kc.getLanguages().then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509590811348,
-  "data": [["zh_CN", "中文简体", true], ["zh_HK", "中文繁体", true], ["en_US", "English", true], ["ja_JP", "日本語", true], ["ru_RU", "русский", true], ["pt_PT", "Portugues", true], ["de_DE", "Deutsch", true], ["nl_NL", "Nederlands", true], ["ko_KR", "한국어", true], ["fr_FR", "Français", true], ["es_ES", "Español", false]]
+const { SpotClient, FuturesClient } = require('kucoin-api');
+
+const client = new SpotClient({
+  apiKey: 'apiKeyHere',
+  apiSecret: 'apiSecretHere',
+  apiPassphrase: 'apiPassPhraseHere',
+});
+
+try {
+  const spotBuyResult = await client.submitOrder({
+    clientOid: client.generateNewOrderID(),
+    side: 'buy',
+    type: 'market',
+    symbol: 'BTC-USDT',
+    size: '0.00001',
+  });
+  console.log('spotBuy ', JSON.stringify(spotBuyResult, null, 2));
+
+  const spotSellResult = await client.submitOrder({
+    clientOid: client.generateNewOrderID(),
+    side: 'sell',
+    type: 'market',
+    symbol: 'BTC-USDT',
+    size: '0.00001',
+  });
+  console.log('spotSellResult ', JSON.stringify(spotSellResult, null, 2));
+} catch (e) {
+  console.error(`Req error: `, e);
 }
 ```
 
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### changeLanguage
+See [SpotClient](./src/SpotClient.ts) and [FuturesClient](./src/FuturesClient.ts) for further information, or the [examples](./examples/) for lots of usage examples.
 
-Change the language for your account.
+## WebSockets
 
-**Parameters**
+All available WebSockets can be used via a shared `WebsocketClient`. The WebSocket client will automatically open/track/manage connections as needed. Each unique connection (one per server URL) is tracked using a WsKey (each WsKey is a string - see [WS_KEY_MAP](src/lib/websocket/websocket-util.ts) for a list of supported values).
 
--   `params` **{lang: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}** The specific language locale to change to from the list provided by getLanguages. (optional, default `{}`)
+Any subscribe/unsubscribe events will need to include a WsKey, so the WebSocket client understands which connection the event should be routed to. See examples below or in the [examples](./examples/) folder on GitHub.
 
-**Examples**
+Data events are emitted from the WebsocketClient via the `update` event, see example below:
 
 ```javascript
-kc.changeLanguage({
-  lang: 'en_US'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509590866149,
-  "data": null
+const { WebsocketClient } = require('kucoin-api');
+
+const client = new WebsocketClient();
+
+client.on('open', (data) => {
+  console.log('open: ', data?.wsKey);
+});
+
+// Data received
+client.on('update', (data) => {
+  console.info('data received: ', JSON.stringify(data));
+});
+
+// Something happened, attempting to reconenct
+client.on('reconnect', (data) => {
+  console.log('reconnect: ', data);
+});
+
+// Reconnect successful
+client.on('reconnected', (data) => {
+  console.log('reconnected: ', data);
+});
+
+// Connection closed. If unexpected, expect reconnect -> reconnected.
+client.on('close', (data) => {
+  console.error('close: ', data);
+});
+
+// Reply to a request, e.g. "subscribe"/"unsubscribe"/"authenticate"
+client.on('response', (data) => {
+  console.info('response: ', data);
+  // throw new Error('res?');
+});
+
+client.on('exception', (data) => {
+  console.error('exception: ', {
+    msg: data.msg,
+    errno: data.errno,
+    code: data.code,
+    syscall: data.syscall,
+    hostname: data.hostname,
+  });
+});
+
+try {
+  // Optional: await a connection to be ready before subscribing (this is not necessary)
+  // await client.connect('futuresPublicV1');
+
+  /**
+   * Examples for public futures websocket topics (that don't require authentication).
+   *
+   * These should all subscribe via the "futuresPublicV1" wsKey. For detailed usage, refer to the ws-spot-public.ts example.
+   */
+  client.subscribe(
+    [
+      '/contractMarket/tickerV2:XBTUSDM',
+      '/contractMarket/ticker:XBTUSDM',
+      '/contractMarket/level2:XBTUSDM',
+      '/contractMarket/execution:XBTUSDM',
+      '/contractMarket/level2Depth5:XBTUSDM',
+      '/contractMarket/level2Depth50:XBTUSDM',
+      '/contractMarket/limitCandle:XBTUSDTM_1hour',
+      '/contract/instrument:XBTUSDM',
+      '/contract/announcement',
+      '/contractMarket/snapshot:XBTUSDM',
+    ],
+    'futuresPublicV1',
+  );
+} catch (e) {
+  console.error(`Subscribe exception: `, e);
 }
 ```
 
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
+See [WebsocketClient](./src/WebsocketClient.ts) for further information and make sure to check the [examples](./examples/) folder for much more detail, especially [ws-spot-public.ts](./examples/ws-spot-public.ts), which explains a lot of detail.
 
-#### getUserInfo
+---
 
-Get account information for the authenticated user.
+## Customise Logging
 
-**Examples**
+Pass a custom logger which supports the log methods `trace`, `info` and `error`, or override methods from the default logger as desired.
 
 ```javascript
-kc.getUserInfo().then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509590943414,
-  "data": {
-    "referrer_code": "XXXXXX",
-    "photoCredentialValidated": false,
-    "videoValidated": false,
-    "language": "en_US",
-    "csrf": "XXXXXXXXXXXXXXXXXXXXXXX=",
-    "oid": "xxxxxxxxxxxxxxxxxxxxxxxx",
-    "baseFeeRate": 1,
-    "hasCredential": false,
-    "phoneValidated": true,
-    "phone": "",
-    "credentialValidated": false,
-    "googleTwoFaBinding": true,
-    "nickname": null,
-    "name": "",
-    "hasTradePassword": false,
-    "currency": null,
-    "emailValidated": true,
-    "email": "hello@example.com"
-  }
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getInviteCount
-
-Get the number of invitees from the authenticated user's referral code.
-
-**Examples**
-
-```javascript
-kc.getInviteCount().then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509591130780,
-  "data": {
-    "countThree": 0,
-    "count": 0,
-    "countTwo": 0
-  }
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getPromotionRewardInfo
-
-Get promotion reward info.
-
-**Parameters**
-
--   `params` **{symbol: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}?** The coin's symbol to retrieve reward info for. (optional, default `{}`)
-
-**Examples**
-
-_Specify a symbol:_
-
-```javascript
-kc.getPromotionRewardInfo({
-  symbol: 'NEO'
-}).then(console.log).catch(console.error)
-```
-
-_Retrieve data for all symbols:_
-
-```javascript
-kc.getPromotionRewardInfo().then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509591205512,
-  "data": {
-    "grantCountDownSeconds": 219994,
-    "drawingCount": 0,
-    "assignedCount": 0
-  }
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getPromotionRewardSummary
-
-Get promotion reward summary.
-
-**Parameters**
-
--   `params` **{symbol: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}?** The coin's symbol to retrieve reward summary for. (optional, default `{}`)
-
-**Examples**
-
-_Specify a symbol:_
-
-```javascript
-kc.getPromotionRewardSummary({
-  symbol: 'NEO'
-}).then(console.log).catch(console.error)
-```
-
-_Retrieve data for all symbols:_
-
-```javascript
-kc.getPromotionRewardSummary().then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509591324280,
-  "data": []
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getDepositAddress
-
-Retrieve the deposit address for a particular coin.
-
-**Parameters**
-
--   `params` **{symbol: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}** The coin's symbol to retrieve an address for. (optional, default `{}`)
-
-**Examples**
-
-```javascript
-kc.getDepositAddress({
-  symbol: 'NEO'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509591494043,
-  "data": {
-    "oid": "xxxxxxxxxxxxxxxxxxxxxxxx",
-    "address": "Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-    "context": null,
-    "userOid": "xxxxxxxxxxxxxxxxxxxxxxxx",
-    "coinType": "GAS",
-    "createdAt": 1509354932000,
-    "deletedAt": null,
-    "updatedAt": 1509354932000,
-    "lastReceivedAt": 1509541029000
-  }
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### createWithdrawal
-
-Create a withdrawal request for the specified coin.
-
-**Parameters**
-
--   `params` **{symbol: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), amount: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), address: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}** Withdrawal details including the coin's symbol, amount, and address to withdraw to. (optional, default `{}`)
-
-**Examples**
-
-```javascript
-kc.createWithdrawal({
-  symbol: 'NEO',
-  amount: 5,
-  address: 'AWcAwoXK6gbMUTojHMHEx8FgEfaVK9Hz5s'
-}).then(console.log).catch(console.error)
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### cancelWithdrawal
-
-Cancel a withdrawal request for the specified coin.
-
-**Parameters**
-
--   `params` **{symbol: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), txOid: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}** Withdrawal details including the coin's symbol and transaction ID for the withdrawal. (optional, default `{}`)
-
-**Examples**
-
-```javascript
-kc.cancelWithdrawal({
-  symbol: 'NEO',
-  txOid: '59fa71673b7468701cd714a1'
-}).then(console.log).catch(console.error)
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getDepositAndWithdrawalRecords
-
-Retrieve deposit and withdrawal record history.
-
-**Parameters**
-
--   `params` **{symbol: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), status: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), limit: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), page: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)}** Record details including the coin's symbol, type, status, limit, and page number for the records. (optional, default `{}`)
-
-**Examples**
-
-```javascript
-kc.getDepositAndWithdrawalRecords({
-  symbol: 'GAS'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509591779228,
-  "data": {
-    "total": 2,
-    "firstPage": true,
-    "lastPage": false,
-    "datas": [{
-      "coinType": "GAS",
-      "createdAt": 1509540909000,
-      "amount": 0.1117,
-      "address": "Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-      "fee": 0,
-      "outerWalletTxid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@gas",
-      "remark": null,
-      "oid": "xxxxxxxxxxxxxxxxxxxxxxxx",
-      "confirmation": 7,
-      "type": "DEPOSIT",
-      "status": "SUCCESS",
-      "updatedAt": 1509541029000
-    }, {
-      "coinType": "GAS",
-      "createdAt": 1509358609000,
-      "amount": 1.1249,
-      "address": "Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-      "fee": 0,
-      "outerWalletTxid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@gas",
-      "remark": null,
-      "oid": "xxxxxxxxxxxxxxxxxxxxxxxx",
-      "confirmation": 6,
-      "type": "DEPOSIT",
-      "status": "SUCCESS",
-      "updatedAt": 1509358729000
-    }],
-    "currPageNo": 1,
-    "limit": 12,
-    "pageNos": 1
-  }
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getBalance
-
-Retrieve balance for a particular coin.
-
-**Parameters**
-
--   `params` **{symbol: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}?** The coin's symbol for the balance you want to retrieve. (optional, default `{}`)
-
-**Examples**
-
-_Retrieve the balance for NEO:_
-
-```javascript
-kc.getBalance({
-  symbol: 'NEO'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509592077557,
-  "data": {
-    "coinType": "NEO",
-    "balanceStr": "10.72040467",
-    "freezeBalance": 0,
-    "balance": 10.72040467,
-    "freezeBalanceStr": "0.0"
-  }
-}
-```
-
-_Retrieve the balance for all coins (including zero balances):_
-
-```javascript
-kc.getBalance().then(console.log).catch(console.error)
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### createOrder
-
-Create an order for the specified trading pair.
-
-**Parameters**
-
--   `params` **{pair: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), amount: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), price: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}** Order details including the trading pair, amount, price, and type of order. (optional, default `{}`)
-
-**Examples**
-
-_Create an order to sell 5 GAS for NEO at the specified price:_
-
-```javascript
-kc.createWithdrawal({
-  pair: 'GAS-NEO',
-  amount: 5,
-  price: 0.608004
-  type: 'SELL'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  success: true,
-  code: 'OK',
-  msg: 'OK',
-  timestamp: 1509592202904,
-  data: {
-    orderOid: 'xxxxxxxxxxxxxxxxxxxxxxxx'
-  }
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getActiveOrders
-
-View a list of active orders for the specified trading pair
-
-**Parameters**
-
--   `params` **{pair: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}** The trading pair to retrieve orders for. (optional, default `{}`)
-
-**Examples**
-
-```javascript
-kc.getActiveOrders({
-  pair: 'GAS-NEO'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509592278263,
-  "data": {
-    "SELL": [[1509592203000, "SELL", 1, 0.11206064, 0, "xxxxxxxxxxxxxxxxxxxxxxxx"]],
-    "BUY": []
-  }
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### cancelOrder
-
-Cancel an order for the specified trading pair.
-
-**Parameters**
-
--   `params` **{pair: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), txOid: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}** Order details including the trading pair and transaction ID for the order. (optional, default `{}`)
-
-**Examples**
-
-```javascript
-kc.cancelOrder({
-  pair: 'GAS-NEO',
-  txOid: '59fa71673b7468701cd714a1'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  success: true,
-  code: 'OK',
-  msg: 'Operation succeeded.',
-  timestamp: 1509592278426,
-  data: null
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getDealtOrders
-
-Retrieve a list of completed orders for the specified trading pair.
-
-**Parameters**
-
--   `params` **{pair: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), limit: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), page: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)}** Order details including the trading pair, type, limit, and page number for the orders. (optional, default `{}`)
-
-**Examples**
-
-```javascript
-kc.getDealtOrders({
-  pair: 'GAS-NEO'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509592427203,
-  "data": {
-    "total": 1,
-    "firstPage": true,
-    "lastPage": false,
-    "datas": [{
-      "coinType": "GAS",
-      "createdAt": 1509455416000,
-      "amount": 0.14494322,
-      "dealValue": 0.0929086,
-      "fee": 0.00009291,
-      "dealDirection": "SELL",
-      "coinTypePair": "NEO",
-      "oid": "xxxxxxxxxxxxxxxxxxxxxxxx",
-      "dealPrice": 0.641,
-      "orderOid": "xxxxxxxxxxxxxxxxxxxxxxxx",
-      "feeRate": 0.001,
-      "direction": "SELL"
-    }],
-    "currPageNo": 1,
-    "limit": 12,
-    "pageNos": 1
-  }
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getTicker
-
-Retrieve current price ticker data for the specified trading pair.
-
-**Parameters**
-
--   `params` **{pair: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)}** The trading pair to retrieve price ticker for. (optional, default `{}`)
-
-**Examples**
-
-```javascript
-kc.getTicker({
-  pair: 'GAS-NEO'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509592566746,
-  "data": {
-    "coinType": "GAS",
-    "trading": true,
-    "symbol": "GAS-NEO",
-    "lastDealPrice": 0.627999,
-    "buy": 0.608004,
-    "sell": 0.628,
-    "change": 0.019994,
-    "coinTypePair": "NEO",
-    "sort": 0,
-    "feeRate": 0.001,
-    "volValue": 5246.36133161,
-    "high": 0.635,
-    "datetime": 1509592566000,
-    "vol": 8499.38951847,
-    "low": 0.601101,
-    "changeRate": 0.0329
-  }
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getOrderBooks
-
-Retrieve a list of orders for the specified trading pair.
-
-**Parameters**
-
--   `params` **{pair: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), group: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), limit: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)}** Order book details including the trading pair, type, group, and limit for the orders. (optional, default `{}`)
-
-**Examples**
-
-_Retrieve all orders currently on the books for the GAS-NEO trading pair:_
-
-```javascript
-kc.getOrderBooks({
-  pair: 'GAS-NEO'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509592645132,
-  "data": {
-    "SELL": [[0.628, 227.1374, 142.6422872], [0.632999, 10, 6.32999], [0.633, 4.20740806, 2.6632893], [0.65, 0.6346, 0.41249], [0.6611, 6.7998, 4.49534778], [0.665699, 0.1875, 0.12481856]],
-    "BUY": [[0.608004, 9.8481, 5.98768419], [0.608003, 21.9264, 13.33131698], [0.608001, 43.8442, 26.65731744], [0.604001, 25.5521, 15.43349395], [0.603, 1.0561, 0.6368283], [0.602006, 25, 15.05015]]
-  }
-}
-```
-
-_Retrieve only SELL orders currently on the books for the GAS-NEO trading pair:_
-
-```javascript
-kc.getOrderBooks({
-  pair: 'GAS-NEO',
-  type: 'SELL'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509592734633,
-  "data": [[0.628, 227.1374, 142.6422872], [0.632999, 10, 6.32999], [0.633, 4.20740806, 2.6632893], [0.65, 0.6346, 0.41249], [0.6611, 6.7998, 4.49534778], [0.665699, 0.1875, 0.12481856]]
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getRecentlyDealtOrders
-
-Retrieve a list of recently completed orders for the specified trading pair.
-
-**Parameters**
-
--   `params` **{pair: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), limit: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), since: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)}** Order book details including the trading pair, limit, and since for the orders. (optional, default `{}`)
-
-**Examples**
-
-```javascript
-kc.getRecentlyDealtOrders({
-  pair: 'GAS-NEO'
-}).then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509592783348,
-  "data": [[1509591191000, "SELL", 0.608005, 10.771, 6.54882186], [1509591198000, "SELL", 0.608005, 10.7648, 6.54505222], [1509591512000, "SELL", 0.608005, 13.0292, 7.92181875], [1509591714000, "BUY", 0.627999, 19.9774, 12.54578722], [1509591951000, "SELL", 0.608005, 15.6217, 9.49807171], [1509592026000, "SELL", 0.608005, 15.2009, 9.2422232], [1509592105000, "SELL", 0.608005, 13.4969, 8.20618268], [1509592219000, "BUY", 0.627999, 20.9506, 13.15695585], [1509592311000, "BUY", 0.627999, 23.5278, 14.77543487], [1509592724000, "SELL", 0.608005, 8.6837, 5.27973302]]
-}
-```
-
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getTradingSymbols
-
-Retrieve a list of available trading pairs.
-
-**Examples**
-
-```javascript
-kc.getTradingSymbols().then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509592839027,
-  "data": [{
-    "coinType": "KCS",
-    "trading": true,
-    "symbol": "KCS-BTC",
-    "lastDealPrice": 0.00009277,
-    "buy": 0.00009003,
-    "sell": 0.0000927,
-    "change": -0.00000322,
-    "coinTypePair": "BTC",
-    "sort": 0,
-    "feeRate": 0.001,
-    "volValue": 139.78123495,
-    "high": 0.00012281,
-    "datetime": 1509592836000,
-    "vol": 1347022.79127505,
-    "low": 0.0000835,
-    "changeRate": -0.0335
-  }, {
-    ...
-  }]
-}
+const { WebsocketClient, DefaultLogger } = require('kucoin-api');
+
+// E.g. customise logging for only the trace level:
+const logger = {
+  // Inherit existing logger methods, using an object spread
+  ...DefaultLogger,
+  // Define a custom trace function to override only that function
+  trace: (...params) => {
+    if (
+      [
+        'Sending ping',
+        // 'Sending upstream ws message: ',
+        'Received pong',
+      ].includes(params[0])
+    ) {
+      return;
+    }
+    console.log('trace', JSON.stringify(params, null, 2));
+  },
+};
+
+const ws = new WebsocketClient(
+  {
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPassphrase: 'apiPassPhraseHere',
+  },
+  logger,
+);
 ```
 
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
-
-#### getTrending
+---
 
-Retrieve a list of trending trading pairs.
+<!-- template_contributions -->
 
-**Examples**
+Have my projects helped you? Share the love, there are many ways you can show your thanks:
 
-```javascript
-kc.getTrending().then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509593321973,
-  "data": [{
-    "coinPair": "KCS-BTC",
-    "deals": [[1509591600000, 0.0000928], [1509588000000, 0.00009421], [1509584400000, 0.00009134], [1509580800000, 0.000096], [1509577200000, 0.00010014], [1509573600000, 0.00010293], [1509570000000, 0.00010368], [1509566400000, 0.000107], [1509562800000, 0.00010496], [1509559200000, 0.0001057], [1509555600000, 0.000108], [1509552000000, 0.0001117], [1509548400000, 0.0001142], [1509544800000, 0.000114], [1509541200000, 0.000114], [1509537600000, 0.0001135], [1509534000000, 0.0001135], [1509530400000, 0.0001011], [1509526800000, 0.00010799], [1509523200000, 0.00011405], [1509519600000, 0.0001164], [1509516000000, 0.00012099], [1509512400000, 0.00012107], [1509508800000, 0.00012244], [1509505200000, 0.00012281], [1509501600000, 0.00012295], [1509498000000, 0.00012348], [1509494400000, 0.0001242], [1509490800000, 0.00012895], [1509487200000, 0.00012897], [1509483600000, 0.00012899], [1509480000000, 0.00012849], [1509476400000, 0.00012987], [1509472800000, 0.00013], [1509469200000, 0.00013188], [1509465600000, 0.00012978], [1509462000000, 0.00012978], [1509458400000, 0.000126], [1509454800000, 0.00012978], [1509451200000, 0.00012562], [1509447600000, 0.00012999], [1509444000000, 0.00013009], [1509440400000, 0.0001346], [1509436800000, 0.00013465], [1509433200000, 0.00013465], [1509429600000, 0.00013376], [1509426000000, 0.00013465], [1509422400000, 0.00013457], [1509418800000, 0.00013489], [1509415200000, 0.00013693], [1509411600000, 0.0001329], [1509408000000, 0.00013499], [1509404400000, 0.00013711], [1509400800000, 0.00013723], [1509397200000, 0.00013999], [1509393600000, 0.00013992], [1509390000000, 0.00014195], [1509386400000, 0.00014284], [1509382800000, 0.0001425], [1509379200000, 0.00014286], [1509375600000, 0.00014406], [1509372000000, 0.00014591], [1509368400000, 0.00014647], [1509364800000, 0.0001457], [1509361200000, 0.00014575], [1509357600000, 0.00014659], [1509354000000, 0.00014998], [1509350400000, 0.0001517], [1509346800000, 0.0001488], [1509343200000, 0.0001488], [1509339600000, 0.00014999], [1509336000000, 0.0001521]]
-  }, {
-    ...
-  }]
-}
-```
+- Star & share my projects.
+- Are my projects useful? Sponsor me on Github and support my effort to maintain & improve them: https://github.com/sponsors/tiagosiebler
+- Have an interesting project? Get in touch & invite me to it.
+- Or buy me all the coffee:
+  - ETH(ERC20): `0xA3Bda8BecaB4DCdA539Dc16F9C54a592553Be06C` <!-- metamask -->
 
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
+<!---
+old ones:
+  - BTC: `1C6GWZL1XW3jrjpPTS863XtZiXL1aTK7Jk`
+  - BTC(SegWit): `bc1ql64wr9z3khp2gy7dqlmqw7cp6h0lcusz0zjtls`
+  - ETH(ERC20): `0xe0bbbc805e0e83341fadc210d6202f4022e50992`
+  - USDT(TRC20): `TA18VUywcNEM9ahh3TTWF3sFpt9rkLnnQa
+-->
+<!-- template_contributions_end -->
 
-#### getCoins
-
-Retrieve a list of available coins.
-
-**Examples**
-
-```javascript
-kc.getCoins().then(console.log).catch(console.error)
-
-// Returns:
-
-{
-  "success": true,
-  "code": "OK",
-  "msg": "Operation succeeded.",
-  "timestamp": 1509593539250,
-  "data": [{
-    "withdrawMinFee": 2,
-    "withdrawMinAmount": 50,
-    "withdrawFeeRate": 0.001,
-    "confirmationCount": 12,
-    "name": "Kucoin Shares",
-    "tradePrecision": 4,
-    "enableWithdraw": true,
-    "enableDeposit": true,
-    "coin": "KCS"
-  }, {
-    ...
-  }]
-}
-```
+### Contributions & Pull Requests
 
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** An object containing the API response.
+Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.
 
-## License
+<!-- template_star_history -->
 
--   Open-source [MIT](https://github.com/Satoshinaire/kucoin-api/blob/master/LICENSE).
--   Main author is [@satoshinaire](https://github.com/satoshinaire).
+## Star History
 
-## Donations
+[![Star History Chart](https://api.star-history.com/svg?repos=tiagosiebler/bybit-api,tiagosiebler/okx-api,tiagosiebler/binance,tiagosiebler/bitget-api,tiagosiebler/bitmart-api,tiagosiebler/gateio-api,tiagosiebler/kucoin-api,tiagosiebler/orderbooks,tiagosiebler/accountstate,tiagosiebler/awesome-crypto-examples&type=Date)](https://star-history.com/#tiagosiebler/bybit-api&tiagosiebler/okx-api&tiagosiebler/binance&tiagosiebler/bitget-api&tiagosiebler/bitmart-api&tiagosiebler/gateio-api&tiagosiebler/kucoin-api&tiagosiebler/orderbooks&tiagosiebler/accountstate&tiagosiebler/awesome-crypto-examples&Date)
 
-NEO / GAS accepted at **AWcAwoXK6gbMUTojHMHEx8FgEfaVK9Hz5s**
+<!-- template_star_history_end -->