WebSocket API

This document describes the WebSocket subscription methods provided by the ChainStream DEX JavaScript SDK. Each method is a wrapper for the corresponding WebSocket API. For detailed parameter descriptions and return value structures, please click the corresponding API link.

​

Candles Data Subscription

​

Subscribe to Candles Data

Subscribe to token price candles data.

client.stream.subscribeTokenCandles()

​

Token Data Subscription

​

Subscribe to Token Stats

Subscribe to token market statistics.

client.stream.subscribeTokenStats()

​

Subscribe to Token Trades

Subscribe to token trading events.

client.stream.subscribeTokenTrades()

​

Subscribe to Wallet Trade

Subscribe to wallet trading event.

client.stream.subscribeWalletTrade()

​

Subscribe to Token Holders

Subscribe to token holder statistics.

client.stream.subscribeTokenHolders()

​

Wallet Data Subscription

​

Subscribe to Wallet Balance

Subscribe to wallet balance information.

client.stream.subscribeWalletBalance()

​

Connection Management

​

Establish Connection

client.stream.connect()

All subscription methods return an Unsubscribe object that can be used to cancel the subscription:

const subscription = client.stream.subscribeTokenCandles(/* ... */);
// Cancel subscription
subscription.unsubscribe();

For detailed parameter descriptions, data formats, and error handling, please refer to the WebSocket API Documentation.