欢迎使用全新的 WEEX API 文档。需要查看旧版本?切换到旧版文档
WEEX
WEEX 合约 WebSocket 数据流

公有频道

端点

行情频道

推送合约 24 小时行情统计,包括价格涨跌幅、加权均价以及最新成交价。行情数据在指标变动时实时推送(通常 100~300 ms 内)。

WSS
{symbol}@ticker
wss://ws-contract.weex.com/v3/ws/public

行情频道 › 流参数

symbol
​string · required

交易对。用于订阅消息 params 中的主题,不附加到 WebSocket 连接地址。

Example: BTCUSDT

行情频道 › 请求参数

method
​string · required

SUBSCRIBE 表示订阅,UNSUBSCRIBE 表示取消订阅。

Example: SUBSCRIBE
params
​string[] · required

每个元素格式为 @ticker,例如 BTCUSDT@ticker。

Example: ["BTCUSDT@ticker"]
id
​number

客户端自定义 ID,服务端会原样返回,用于匹配请求。

Example: 1

行情频道 › 响应

行情频道

e
​string

事件类型,固定为 ticker。

E
​number

事件时间(毫秒)。

s
​string

交易对(大写),例如 BTCUSDT。

​object[]

行情数据数组。

p
​string

24 小时价格涨跌额。

P
​string

24 小时价格涨跌幅百分比。

w
​string

24 小时加权平均价。

c
​string

最新成交价。

o
​string

24 小时开盘价。

h
​string

24 小时最高价。

l
​string

24 小时最低价。

v
​string

24 小时成交量(基础币)。

q
​string

24 小时成交额(计价币)。

O
​number

统计开始时间(毫秒)。

C
​number

统计结束时间(毫秒)。

n
​number

24 小时成交笔数。

m
​string

最新标记价格。

i
​string

最新指数价格。


K线频道

推送指定交易对的 K 线(蜡烛图)数据。订阅成功后,服务端以事件类型 kline 实时推送对应周期与价格类型的更新。

WSS
{symbol}@kline_{interval}_{priceType}
wss://ws-contract.weex.com/v3/ws/public

K线频道 › 流参数

symbol
​string · required

交易对。用于订阅消息 params 中的主题,不附加到 WebSocket 连接地址。

Example: ETHUSDT
interval
​string · enum · required

K 线周期,区分大小写。

Enum values:
1m
5m
15m
30m
1h
2h
4h
6h
Example: 1m
priceType
​string · enum · required

K 线价格类型。

Enum values:
LAST_PRICE
MARK_PRICE
Example: LAST_PRICE

K线频道 › 请求参数

method
​string · required

SUBSCRIBE 订阅,UNSUBSCRIBE 取消订阅。

Example: SUBSCRIBE
params
​string[] · required

@kline__,例如 BTCUSDT@kline_1m_LAST_PRICE。

Example: ["ETHUSDT@kline_1m_LAST_PRICE"]
id
​number

客户端自定义 ID,用于匹配回执。

Example: 4

K线频道 › 响应

K线频道

e
​string

事件类型,固定为 kline。

E
​number

事件时间(毫秒)。

s
​string

交易对(大写)。

p
​string

价格类型(如 LAST_PRICE)。

​object[]

K 线数组,通常只包含正在更新的最新一根。

t
​number

K 线开始时间(毫秒)。

T
​number

K 线结束时间(毫秒)。

s
​string

交易对(大写)。

i
​string

订阅时使用的周期 token(如 1m)。

o
​string

开盘价。

c
​string

收盘价。

h
​string

最高价。

l
​string

最低价。

v
​string

成交量(基础币)。

n
​number

成交笔数。

q
​string

成交额(计价币)。

V
​string

主动买入成交量。

Q
​string

主动买入成交额。


深度频道

推送合约订单簿深度变化,事件类型为 depth,根据订阅的交易对和档位实时返回变动。

WSS
{symbol}@depth{level}
wss://ws-contract.weex.com/v3/ws/public

深度频道 › 流参数

symbol
​string · required

交易对。用于订阅消息 params 中的主题,不附加到 WebSocket 连接地址。

Example: BTCUSDT
level
​integer · enum · required

推送的深度档位。

Enum values:
15
200
Example: 15

深度频道 › 请求参数

method
​string · required

SUBSCRIBE 订阅,UNSUBSCRIBE 取消订阅。

Example: SUBSCRIBE
params
​string[] · required

@depth{level},支持 15、200 档。例如:BTCUSDT@depth15。

Example: ["BTCUSDT@depth15"]
id
​number

客户端自定义 ID,服务端原样返回。

Example: 2

深度频道 › 响应

深度频道

e
​string

事件类型,depth。

E
​number

事件时间(毫秒)。

s
​string

交易对。

U
​number

本次推送的首个 update ID。

u
​number

本次推送的最后一个 update ID。

l
​number

深度档位。

d
​string

深度类型,增量为 CHANGED。

​array[]

变更后的买盘 [价格, 数量]。

string[]
index[0]
​string

买单价格。

Example: 103435.90
index[1]
​string

该价格档位的买单数量。

Example: 2.10000
​array[]

变更后的卖盘 [价格, 数量]。

string[]
index[0]
​string

卖单价格。

Example: 103436.10
index[1]
​string

该价格档位的卖单数量。

Example: 1.21500
f
​string

合并深度的 merge factor(仅在存在时返回)。


平台成交详情频道

推送合约的最新成交(taker 订单)。订阅成功后,以事件类型 trade 实时推送成交数据。

WSS
{symbol}@trade
wss://ws-contract.weex.com/v3/ws/public

平台成交详情频道 › 流参数

symbol
​string · required

交易对。用于订阅消息 params 中的主题,不附加到 WebSocket 连接地址。

Example: BTCUSDT

平台成交详情频道 › 请求参数

method
​string · required

SUBSCRIBE 订阅,UNSUBSCRIBE 取消订阅。

Example: SUBSCRIBE
params
​string[] · required

@trade,例如 BTCUSDT@trade。

Example: ["BTCUSDT@trade"]
id
​number

客户端自定义 ID,服务端原样返回。

Example: 3

平台成交详情频道 › 响应

平台成交详情频道

e
​string

事件类型,固定为 trade。

E
​number

事件时间(毫秒)。

s
​string

交易对(大写)。

​object[]

成交明细数组,通常包含最新的成交。

T
​number

成交时间(毫秒)。

t
​number

成交 ID。

p
​string

成交价格。

q
​string

成交数量。

v
​string

成交额(价格 × 数量)。

m
​boolean

是否为卖方主动成交(true 表示卖出为主动方)。