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.
WebSocket API: Candles Data
client.stream.subscribeTokenCandles()

Token Data Subscription

Subscribe to Token Stats

Subscribe to token market statistics.
WebSocket API: Token Stats
client.stream.subscribeTokenStats()

Subscribe to Hot Tokens Stats

Subscribe to market statistics for trending tokens.
WebSocket API: Hot Tokens Stats
client.stream.subscribeHotTokenStats()

Subscribe to New Tokens Stats

Subscribe to market statistics for newly listed tokens.
WebSocket API: New Tokens Stats
client.stream.subscribeNewTokenStats()

Subscribe to New Tokens Metadata

Subscribe to metadata for newly listed tokens.
WebSocket API: New Tokens Metadata
client.stream.subscribeNewTokensMetadata()

Subscribe to New Tokens

Subscribe to information about newly created tokens.
WebSocket API: New Tokens
client.stream.subscribeNewTokens()

Subscribe to Token Holders

Subscribe to token holder statistics.
client.stream.subscribeTokenHolders()

Subscribe to Token Supply

Subscribe to token supply and market cap information.
WebSocket API: Token Supply
client.stream.subscribeTokenSupply()

Subscribe to DEX Pool Balance

Subscribe to DEX pool balance information.
WebSocket API: DEX Pool Balance
client.stream.subscribeDexPoolBalance()

Subscribe to Token Liquidity

Subscribe to token liquidity statistics.
WebSocket API: Token Liquidity
client.stream.subscribeTokenLiquidity()

Wallet Data Subscription

Subscribe to Wallet PnL

Subscribe to wallet profit and loss (PnL) statistics.
WebSocket API: Wallet PnL Data
client.stream.subscribeWalletPnl()

Subscribe to Wallet Balance

Subscribe to wallet balance information.
WebSocket API: Wallet Balance
client.stream.subscribeWalletBalance()

Trade Data Subscription

Subscribe to Token Trades

Subscribe to token trading events.
WebSocket API: Token Trade
client.stream.subscribeTokenTrades()

Subscribe to Wallet Trade

Subscribe to wallet trading event.
WebSocket API: Wallet Trade
client.stream.subscribeWalletTrade()

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.