KuCoin JavaScript SDK example: ws-private-spot-v1.ts
KuCoin websocket private spot V1 JavaScript example for the Siebly KuCoin SDK, covering exchange REST API and WebSocket integration, setup, and production SDK docs.
We use environment variables in our examples for API keys. It is your responsibility to manage and secure your keys appropriately.
examples/Kucoin/WebSockets/ws-private-spot-v1.ts
What this example covers
- KuCoin WebSocket stream JavaScript example.
- Uses the Siebly KuCoin SDK package
kucoin-apiinstead of hand-written WebSocket plumbing. - Source path:
Kucoin/WebSockets/ws-private-spot-v1.ts. - Imports SDK symbols including
DefaultLogger,WebsocketClient. - Calls SDK methods such as
on(),connect(),subscribe().
How to use this example
- Start here for the specific request or stream pattern, then check the matching SDK guide for install, credentials, and operational notes.
- For WebSocket examples, keep reconnect, resubscribe, heartbeat, and event-handler behavior explicit in your service.
- Open the repository source when you need the latest committed version: GitHub source file.
/* eslint-disable @typescript-eslint/no-unused-vars */import { DefaultLogger, WebsocketClient } from 'kucoin-api'; async function start() { // Optional: inject a custom logger to override internal logging behaviour // const logger: typeof DefaultLogger = { // ...DefaultLogger, // trace: (...params) => { // if ( // [ // 'Sending ping', // // 'Sending upstream ws message: ', // 'Received pong', // ].includes(params[0]) // ) { // return; // } // console.log('trace', JSON.stringify(params, null, 2)); // }, // }; const account = { key: process.env.API_KEY || 'keyHere', secret: process.env.API_SECRET || 'secretHere', passphrase: process.env.API_PASSPHRASE || 'apiPassPhraseHere', // This is NOT your account password }; console.log('connecting with ', account); const client = new WebsocketClient( { apiKey: account.key, apiSecret: account.secret, apiPassphrase: account.passphrase, }, // logger, ); 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 reconnect 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('spotPrivateV1'); // console.log('connected'); /** * For more detailed usage info, refer to the ws-spot-public.ts example. * * Below are some examples for subscribing to private spot & margin websockets. * Note: all "private" websocket topics should use the "spotPrivateV1" wsKey. */ client.subscribe( [ '/market/match:BTC-USDT', '/spotMarket/tradeOrders', '/spotMarket/tradeOrdersV2', '/account/balance', '/spotMarket/advancedOrders', ], 'spotPrivateV1', ); /** * Other margin websocket topics, which also use the "spotPrivateV1" WsKey: */ client.subscribe( [ '/margin/position', '/margin/isolatedPosition:BTC-USDT', '/spotMarket/advancedOrders', ], 'spotPrivateV1', ); } catch (e) { console.error('Subscribe exception: ', e); }} start();