订阅成交变动数据

trade.$contract_code

是否验签: 是

接口权限: 读取

限频: WebSocket私有订单成交推送接口(需要API KEY验签) 一个UID最多同时建立30个私有订单成交推送WS链接。该用户在一个品种(包含该品种的所有周期的合约)上，仅需要维持一个订单推送WS链接即可。 单个链接为50次/秒的请求，单个IP链接为100次/秒的请求。 注意: 订单推送WS的限频，跟用户RESTFUL私有接口的限频是分开的，相互不影响。

接口描述: 发生成交事件时，推送如下消息。

订阅地址

环境	地址
线上环境	wss://api.sunx.io/ws/v1/notification
线上环境（aws客户首选）	wss://api.sunx.io/ws/v1/notification

请求参数

字段名称	类型	说明
op	string	必填;操作名称，sub 或 unsub;
cid	string	选填;Client 请求唯一 ID
topic	string	必填; trade
contract_code	string	必填; contract_code * 或者 BTC-USDT 或者 BTC-USDT-240909

规则说明

订阅(sub)	取消订阅(unsub)	规则
*	*	yes
*	contract_code	no

订阅参数

参数	数据类型	是否必填	描述	取值范围	默认值
contract_code	string	true	合约代码，支持大小写	全部：*（交割和永续）， 永续:“BTC-USDT：... ，交割："BTC-USDT-210625"...

数据更新

参数	数据类型	是否必填	描述	取值范围
op	String	true	操作名称，推送固定值为 notify;--可不可以去掉
topic	String	true	推送的主题	trade
ts	long	true	服务端应答时间戳
uid	String	true	用户uid
<data>		false
contract_code	String	true	交易对。常用形式为“基础货币”+“报价货币”
order_id	String	true	订单ID
client_order_id	String	true	用户自定义订单ID
id	String	true	成交id
direction	String	true	交易方向	buy表示买，sell表示卖。
position_side	String	true	仓位方向	"long":多，"short":空，“both”:单向持仓。
role	String	true	成交角色maker, taker
trade_price	String	true	成交价格
trade_volume	String	true	成交量（张）
trade_turnover	String	true	成交金额（成交数量 * 合约面值 * 成交价格）
created_time	String	true	创建时间
updated_time	String	true	更新时间，默认为撮合成交时间
contract_type	String	true	合约类型	swap（永续）、this_week（当周）、next_week（次周）、quarter（当季）、next_quarter（次季
<data>		false

订阅示例

{
  "op": "sub",
  "cid": "ovILlciUtO",
  "topic": "trade",
  "contract_code": "*"
}

订阅成功示例

{
  "op": "auth",
  "type": "api",
  "err-code": 0,
  "ts": 1734575734395,
  "data": {
    "user-id": "41312018"
  }
}

数据更新示例

{
    "op":"notify"
    "topic":"trade"
    "contract_code":"SHIB-USDT"
    "ts":1749468764319
    "uid":"502061937"
    "data":[
        0:{
            "direction":"sell"
            "position_side":"short"
            "id":"100005308993680-1381717672952373248-1"
            "contract_code":"SHIB-USDT"
            "contract_type":"swap"
            "order_id":1381717672952373200
            "trade_id":100005308993680
            "trade_volume":"1"
            "trade_price":"0.000012686"
            "trade_turnover":"0.012686"
            "role":"taker"
            "client_order_id":"111111222267"
            "created_time":1749468764304
            "updated_time":1749468764315
        }
    ]
}