Public Channels

Endpoint

Market Channel

Streams 24‑hour ticker statistics for a symbol, including last price, price change, weighted averages, and top-of-book quotes. Updates are pushed whenever upstream metrics change (typically within 100‑300 ms).

WSS

{symbol}@ticker

wss://ws-spot.weex.com/v3/ws/public

Market Channel › Stream Parameters

symbol

string · required

Trading pair. Used in the subscription topic inside params, not appended to the WebSocket URL.

Example: BTCUSDT

Market Channel › Request Parameters

method

string · required

Use SUBSCRIBE to add, UNSUBSCRIBE to remove subscriptions.

Example: SUBSCRIBE

params

string[] · required

Each entry uses the format @ticker, e.g. BTCUSDT@ticker.

Example: ["BTCUSDT@ticker"]

id

number

Client-defined identifier echoed in the acknowledgement.

Example: 1

Market Channel › Responses

Market Channel

e

string

Event type, 24hrTicker.

E

number

Event time in milliseconds.

s

string

Trading pair in uppercase (e.g. BTCUSDT).

object

24‑hour statistics.

Book Ticker Channel

Streams best bid/ask quotes for a symbol. Messages are pushed whenever the top of book changes.

WSS

{symbol}@bookTicker

wss://ws-spot.weex.com/v3/ws/public

Book Ticker Channel › Stream Parameters

symbol

string · required

Trading pair. Used in the subscription topic inside params, not appended to the WebSocket URL.

Example: BTCUSDT

Book Ticker Channel › Request Parameters

method

string · required

Use SUBSCRIBE to add, UNSUBSCRIBE to remove subscriptions.

Example: SUBSCRIBE

params

string[] · required

Each entry uses the format @bookTicker, e.g. BTCUSDT@bookTicker.

Example: ["BTCUSDT@bookTicker"]

id

number

Client-defined identifier echoed in the acknowledgement.

Example: 1

Book Ticker Channel › Responses

Book Ticker Channel

e

string

Event type, bookTicker.

E

number

Event time in milliseconds.

s

string

Trading pair in uppercase (e.g. BTCUSDT).

object

Best bid/ask snapshot.

Depth Channel

Streams order book depth changes (depth) for the requested trading pair and aggregation level. A snapshot is delivered automatically after subscribing, followed by incremental updates.

WSS

{symbol}@depth{level}

wss://ws-spot.weex.com/v3/ws/public

Depth Channel › Stream Parameters

symbol

string · required

Trading pair. Used in the subscription topic inside params, not appended to the WebSocket URL.

Example: BTCUSDT

level

integer · enum · required

Number of order book levels to stream.

Enum values:

200

Example: 15

Depth Channel › Request Parameters

method

string · required

SUBSCRIBE to add, UNSUBSCRIBE to remove.

Example: SUBSCRIBE

params

string[] · required

@depth{level}. Supported levels: 15, 200. Example: BTCUSDT@depth15.

Example: ["BTCUSDT@depth15"]

id

number

Client-defined identifier echoed in the acknowledgement.

Example: 2

Depth Channel › Responses

Depth Channel

e

string

Event type, depth.

E

number

Event time in milliseconds.

s

string

Trading pair (uppercase, e.g. BTCUSDT).

U

number

First update ID in this message.

u

number

Last update ID in this message.

l

number

Depth level (15 or 200).

d

string

Depth type (SNAPSHOT on the initial response, CHANGED afterwards).

array[]

Bid updates in [price, size] format.

array[]

Ask updates in [price, size] format.

f

string

Merge factor (only present when merged depths are enabled).

Candlestick Channel

Streams candlestick (K-line) data for the requested symbol. Each update contains the latest bar for the specified interval and price type.

WSS

{symbol}@kline_{interval}_{priceType}

wss://ws-spot.weex.com/v3/ws/public

Candlestick Channel › Stream Parameters

symbol

string · required

Trading pair. Used in the subscription topic inside params, not appended to the WebSocket URL.

Example: ETHUSDT

interval

string · enum · required

Candlestick interval; case-sensitive.

Enum values:

15m

30m

Example: 1m

priceType

string · enum · required

Candlestick price type.

Enum values:

LAST_PRICE

MARK_PRICE

Example: LAST_PRICE

Candlestick Channel › Request Parameters

method

string · required

SUBSCRIBE or UNSUBSCRIBE.

Example: SUBSCRIBE

params

string[] · required

@kline__, e.g. BTCUSDT@kline_1m_LAST_PRICE.

Example: ["ETHUSDT@kline_1m_LAST_PRICE"]

id

number

Client identifier echoed in the acknowledgement.

Example: 4

Candlestick Channel › Responses

Candlestick Channel

e

string

Event type, kline.

E

number

Event time (milliseconds).

s

string

Trading pair (e.g. ETHUSDT).

p

string

Price type (LAST_PRICE, MARK_PRICE).

object[]

Candlestick entries (typically the most recent bar).

Public Trade Channel

Streams taker trades for the subscribed symbol. Each trade update represents one or more recent executions.

WSS

{symbol}@trade

wss://ws-spot.weex.com/v3/ws/public

Public Trade Channel › Stream Parameters

symbol

string · required

Trading pair. Used in the subscription topic inside params, not appended to the WebSocket URL.

Example: BTCUSDT

Public Trade Channel › Request Parameters

method

string · required

SUBSCRIBE or UNSUBSCRIBE.

Example: SUBSCRIBE

params

string[] · required

@trade, e.g. BTCUSDT@trade.

Example: ["BTCUSDT@trade"]

id

number

Client identifier echoed in the acknowledgement.

Example: 3

Public Trade Channel › Responses

Public Trade Channel

e

string

Event type, trade.

E

number

Event time in milliseconds.

s

string

Trading pair (uppercase).

object[]

Trade entries.

Private Channels