CrossEx WebSocket v1.0.0

CrossEx 提供简单而强大的 Websocket API，将交易状态集成到您的业务或应用程序中。

服务器地址

• 线上地址：
  • 公有行情：wss://api.gateio.ws/ws/crossex/public
  • 私有推送：wss://api.gateio.ws/ws/crossex
• 心跳机制：客户端需每隔 30 秒内向 WebSocket 服务器发送一次协议层Ping帧以维持连接，若服务器超过 30 秒未收到该帧，将自动断开连接。
• ws连接数量限制：每个uid+channel限制20个连接

变更日志

Jul 15 2026

1. 新增批量撤单 API 频道（batch_cancel_orders）

Jul 9 2026

1. 新增ADL排名订阅频道（adl_rank），提供交易所底层rank和CrossEx自身rank

Jul 2 2026

1. CrossEx新增支持DERIBIT交易所

Jun 9 2026

1. CrossEx新增支持HYPERLIQUID交易所

May 19 2026

1. CrossEx新增支持KRAKEN交易所

Mar 24 2026

1. 新增Ticker订阅频道（ticker），提供各大交易所现货/合约的ticker推送
2. 新增公有成交订阅频道（trade），提供各大交易所现货/合约的逐笔成交推送
3. 新增K线订阅频道（kline_x），支持1m/5m/15m/30m/1h/4h/1d多个周期
4. 新增合约资金费率订阅频道（funding_rate），提供合约的资金费率推送
5. 新增合约持仓总量订阅频道（open_interest），提供合约的持仓总量推送（除BINANCE外）

Mar 12 2026

1. CrossEx新增支持BYBIT交易所

Feb 27 2026

1. 新增公有行情推送，包括最新成交价，指数价格，标记价格
2. 新增增量订单薄深度和全量订单薄深度订阅

Jan 21 2026

1. 增加channel完全平仓
2. 添加连接数量限制说明
3. 添加所有 API 的限频说明

Jan 19 2026

1. 新增杠杆仓位订阅/取消订阅
2. 新增杠杆利息订阅/取消订阅
3. 新增修改现货杠杆的杠杆倍数

Websocket API 概述

事件

每个通用频道（例如订单、资产等）都支持 2 种不同的事件消息，它们是：

1. subscribe (推荐使用)

   订阅，接受服务器的新数据推送。

2. unsubscribe

   如果取消订阅，服务器将不会发送新数据推送。

请求参数

每个请求都遵循通用格式，其中包含 time, channel, event 和 payload。

名称	类型	必选	描述
time	Integer	是	请求时间
channel	String	是	请求 subscribe/unsubscribe 频道
auth	Object	否	请求身份验证信息，请参阅身份验证部分了解详细信息
event	String	是	请求 event (subscribe/unsubscribe/api/login)
payload	Array/Object	是	请求详细参数

推送参数

与请求类似，推送参数遵循以下通用格式，其中包含： time, channel, event, error 和 result.

名称	类型	必选	描述
time	Integer	是	推送时间
channel	String	是	推送频道
event	String	是	推送频道事件 (subscribe/update)
error	Object	否	推送错误
result	Any	是	返回来自服务端的新数据通知 或 对客户端请求的响应。如果有错误返回则 error 不为空，没有错误则此字段为空。

注意：如果它是服务端发起的数据更新通知 那么 result 的类型是基于 channel 的，不同 channel 的 result 类型有所不同。

但如果是对客户端订阅请求的响应，那么 result 为固定的 {"code": "100000", "message": "success"}。 验证订阅请求是否成功，您只需要检查 error 字段是否为空即可，不需要再解析 result 字段。

为了简单起见，下面的频道（channel）描述只给出对应频道的 payload 格式。

错误

如果出现错误，您会收到 error 字段，其中包含错误代码和错误的类型。

Code	Message
100001	参数丢失或无效
100002	未登陆
100003	连接达到最大数
100004	超时
100005	操作失败
100006	登陆失败
100007	网络错误，请稍后再试

鉴权

WARNING

注意: 您使用的 GateAPIv4 密钥对必须至少启用 CrossEx 读取权限， 如果启用了密钥的白名单，则您的出站 IP 地址必须在密钥的 IP 白名单中。

# example WebSocket signature calculation implementation in Python
import hmac, hashlib, json, time


def gen_sign(channel, event, timestamp):
    # GateAPIv4 key pair
    api_key = 'YOUR_API_KEY'
    api_secret = 'YOUR_API_SECRET'

    s = 'channel=%s&event=%s&time=%d' % (channel, event, timestamp)
    sign = hmac.new(api_secret.encode('utf-8'), s.encode('utf-8'), hashlib.sha512).hexdigest()
    return {'method': 'api_key', 'api_key': api_key, 'sign': sign}


request = {
    'time': int(time.time()),
    'event': 'login',
    'payload': {
        'method': 'api_key',
        'api_key': 'YOUR_API_KEY',
        'sign': gen_sign('', 'login', int(time.time()))['sign']
    }
}
print(json.dumps(request))

如果频道是私有的，例如，客户端请求需要携带身份验证信息。例如： order检索用户订单更新的频道。

身份验证通过请求正文中的payload字段发送，格式如下:

名称	类型	描述
method	String	验证方式: api_key
api_key	String	apiKey 的值
sign	String	签名结果

WebSocket 认证使用与 Gate APIv4 API 相同的签名计算方法，即HexEncode(HMAC_SHA512(secret, signature_string)), 但有以下区别:

1. 签名字符串拼接方式： channel=<channel>&event=<event>&time=<time>, 其中 <channel>, <event>, <time> 是对应的请求信息
2. 身份验证信息在请求正文中的 payload字段中发送。

您可以登录账户获取 CrossEx 账户的 api_key 和 secret。

认证

» event: login

» method: api_key

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件 login
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	object	是	none
»» method	body	string	是	验证方式
»» api_key	body	string	是	api key
»» sign	body	string	是	签名

请求示例

{
   "time": 1754272114,
   "event": "login",
   "request_id": "request-1",
   "payload": {
      "method": "api_key",
      "api_key": "0d5245a5d8be8ac0e96ed8aaa47386cf",
      "sign": "568e694ebf998fc0e9a26ab26c8cb962d8649fd61fbfc61f068251ae8169f00066b3205bb2491c1625e111f18c4bf1e6bcf8d3fd519eaea8b7335edea960eee2"
   }
}

返回数据结构

名称	类型	必选	约束	释义	说明
» event	string	true	none		事件 api
» request_id	string	false	none		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	object	true	none		none
»» conn_id	string	true	none		连接ID
» result	object	true	none		登陆结果
»» code	string	true	none		响应码
»» message	string	true	none		响应消息
» time	integer	true	none		时间戳（秒）
» time_ms	integer	true	none		时间戳（毫秒）

返回示例

{
   "event": "login",
   "request_id": "request-1", 
   "payload": {
      "conn_id": "644ff57f-add4-407a-97aa-b654c4ede839"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168928
}

最新成交价订阅

last_price

最新成交价频道提供各大交易所的现货/杠杆，合约的最新成交价格更新推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: last_price

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "last_price",
   "payload": [
      "BINANCE_SPOT_BTC_USDT",
      "OKX_FUTURE_BTC_USDT",
      "GATE_FUTURE_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
   "time": 1771988975,
   "channel": "last_price",
   "event": "update",
   "result": {
      "s": "BINANCE_SPOT_BTC_USDT",
      "lp": "65873.49000000"
   },
   "time_ms": 1771988975033
}

{
   "time": 1771988975,
   "channel": "last_price",
   "event": "update",
   "result": {
      "s": "OKX_FUTURE_BTC_USDT",
      "lp": "65843.3"
   },
   "time_ms": 1771988975120
}

{
   "time": 1771988978,
   "channel": "last_price",
   "event": "update",
   "result": {
      "s": "GATE_FUTURE_ETH_USDT",
      "lp": "1918.01"
   },
   "time_ms": 1771988978067
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» s	string	true	none	交易对	Symbol
»» lp	string	true	none	最新成交价	LastPrice

指数价格订阅

index_price

指数频道提供各大交易所的现货杠杆的指数价格更新推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: index_price

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "index_price",
   "payload": [
      "BINANCE_MARGIN_BTC_USDT",
      "OKX_MARGIN_BTC_USDT",
      "GATE_MARGIN_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
   "time": 1771990104,
   "channel": "index_price",
   "event": "update",
   "result": {
      "s": "BINANCE_MARGIN_BTC_USDT",
      "ip": "65590.40739130"
   },
   "time_ms": 1771990104116
}

{
   "time": 1771990103,
   "channel": "index_price",
   "event": "update",
   "result": {
      "s": "OKX_MARGIN_BTC_USDT",
      "ip": "65591.5"
   },
   "time_ms": 1771990103520
}

{
   "time": 1771990106,
   "channel": "index_price",
   "event": "update",
   "result": {
      "s": "GATE_MARGIN_BTC_USDT",
      "ip": "65589.9"
   },
   "time_ms": 1771990106074
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» s	string	true	none	交易对	Symbol
»» ip	string	true	none	指数价格	IndexPrice

标记价格订阅

mark_price

指数频道提供各大交易所的现货杠杆的指数价格更新推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: mark_price

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "mark_price",
   "payload": [
      "BINANCE_FUTURE_BTC_USDT",
      "OKX_FUTURE_BTC_USDT",
      "GATE_FUTURE_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
   "time": 1771990349,
   "channel": "mark_price",
   "event": "update",
   "result": {
      "s": "BINANCE_FUTURE_BTC_USDT",
      "mp": "65566.30000000"
   },
   "time_ms": 1771990349113
}

{
   "time": 1771990348,
   "channel": "mark_price",
   "event": "update",
   "result": {
      "s": "OKX_FUTURE_BTC_USDT",
      "mp": "65562.8"
   },
   "time_ms": 1771990348142
}

{
   "time": 1771990349,
   "channel": "mark_price",
   "event": "update",
   "result": {
      "s": "GATE_FUTURE_ETH_USDT",
      "mp": "1908.90"
   },
   "time_ms": 1771990349066
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» s	string	true	none	交易对	Symbol
»» mp	string	true	none	标记价格	MarkPrice

全量有限档订单薄订阅

order_book_x

其中 x 表示订单薄快照档位，不同交易所支持的档位如下：

• BINANCE：[5, 10, 20]
• OKX：[1, 5]
• GATE：
  • SPOT：[5, 10, 20, 30, 50, 100]
  • FUTURE：[1, 5, 10, 20, 50, 100]
• BYBIT：[1]
• KRAKEN：不支持 order_book_x 快照档位，请使用 order_book_update
• HYPERLIQUID：[1, 5, 10, 20, 30, 50, 100, 400]
• DERIBIT：[1, 5, 10, 20]

全量有限档订单薄频道提供各大交易所的现货/合约订单薄深度全量有限档推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: order_book_x

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "order_book_5",
   "payload": [
      "BINANCE_SPOT_BTC_USDT",
      "OKX_FUTURE_BTC_USDT",
      "GATE_FUTURE_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
   "time": 1771990690,
   "channel": "order_book_5",
   "event": "update",
   "result": {
      "ts": 1771990690844,
      "s": "BINANCE_SPOT_BTC_USDT",
      "a": [
         [
            "65485.33000000",
            "2.25708000"
         ],
         [
            "65485.34000000",
            "0.00025000"
         ],
         [
            "65485.38000000",
            "0.15432000"
         ],
         [
            "65485.39000000",
            "0.50423000"
         ],
         [
            "65486.26000000",
            "0.00208000"
         ]
      ],
      "b": [
         [
            "65485.32000000",
            "0.04107000"
         ],
         [
            "65485.31000000",
            "0.00097000"
         ],
         [
            "65485.20000000",
            "0.00008000"
         ],
         [
            "65485.10000000",
            "0.00018000"
         ],
         [
            "65484.99000000",
            "0.00045000"
         ]
      ]
   },
   "time_ms": 1771990690844
}

{
   "time": 1771990690,
   "channel": "order_book_5",
   "event": "update",
   "result": {
      "ts": 1771990690900,
      "s": "OKX_FUTURE_BTC_USDT",
      "a": [
         [
            "65457.1",
            "997.61"
         ],
         [
            "65457.2",
            "0.01"
         ],
         [
            "65458",
            "0.01"
         ],
         [
            "65458.1",
            "106.34"
         ],
         [
            "65458.4",
            "0.01"
         ]
      ],
      "b": [
         [
            "65457",
            "121.04"
         ],
         [
            "65456.9",
            "0.03"
         ],
         [
            "65456.8",
            "0.01"
         ],
         [
            "65456",
            "0.01"
         ],
         [
            "65455.9",
            "0.01"
         ]
      ]
   },
   "time_ms": 1771990690905
}

{
   "time": 1771990690,
   "channel": "order_book_5",
   "event": "update",
   "result": {
      "ts": 1771990690848,
      "s": "GATE_FUTURE_ETH_USDT",
      "a": [
         [
            "1906.86",
            "3638"
         ],
         [
            "1907.01",
            "99"
         ],
         [
            "1907.05",
            "194"
         ],
         [
            "1907.1",
            "1686"
         ],
         [
            "1907.11",
            "5098"
         ]
      ],
      "b": [
         [
            "1906.85",
            "7139"
         ],
         [
            "1906.8",
            "1"
         ],
         [
            "1906.79",
            "3382"
         ],
         [
            "1906.7",
            "43"
         ],
         [
            "1906.65",
            "74"
         ]
      ]
   },
   "time_ms": 1771990690887
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» ts	long	true	none	毫秒时间戳	Symbol
»» s	string	true	none	交易对	Symbol
»» a	array	true	none	卖盘深度	[Price,Qty]
»» b	array	true	none	买盘深度	[Price,Qty]

增量订单薄订阅

order_book_update

增量订单薄频道提供各大交易所的现货/合约的订单薄深度增量推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: order_book_update

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "order_book_update",
   "payload": [
      "BINANCE_FUTURE_BTC_USDT",
      "OKX_FUTURE_BTC_USDT",
      "GATE_FUTURE_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
   "time": 1771991193,
   "channel": "order_book_update",
   "event": "update",
   "result": {
      "snapshot": false,
      "ts": 1771991193314,
      "s": "BINANCE_FUTURE_BTC_USDT",
      "U": 88686516370,
      "u": 88686516769,
      "a": [
         [
            "65475.36000000",
            "0.00000000"
         ],
         [
            "65475.37000000",
            "0.00000000"
         ]
      ],
      "b": [
         [
            "65479.75000000",
            "0.96961000"
         ],
         [
            "65478.71000000",
            "0.03395000"
         ]
      ]
   },
   "time_ms": 1771991193344
}

{
   "time": 1771991192,
   "channel": "order_book_update",
   "event": "update",
   "result": {
      "snapshot": false,
      "ts": 1771991192200,
      "s": "OKX_FUTURE_BTC_USDT",
      "U": 298872114996,
      "u": 298872115067,
      "a": [
         [
            "65458.8",
            "692.41"
         ],
         [
            "65463.4",
            "0.3"
         ],
         [
            "65464.9",
            "28.64"
         ],
         [
            "65465",
            "0"
         ],
         [
            "65466.4",
            "0"
         ],
         [
            "65466.9",
            "29.57"
         ],
         [
            "65468",
            "4.98"
         ],
         [
            "65471.5",
            "0.37"
         ],
         [
            "65479.2",
            "0.29"
         ],
         [
            "65483.8",
            "0.05"
         ],
         [
            "65492.6",
            "0.02"
         ],
         [
            "65503.8",
            "0.02"
         ],
         [
            "65510.1",
            "0"
         ]
      ],
      "b": [
         [
            "65458.7",
            "174.61"
         ],
         [
            "65449.5",
            "2.3"
         ],
         [
            "65448.6",
            "99.61"
         ],
         [
            "65444.9",
            "0.33"
         ],
         [
            "65432.6",
            "29.59"
         ],
         [
            "65432.3",
            "15.6"
         ],
         [
            "65431.4",
            "0"
         ],
         [
            "65431.3",
            "2.62"
         ],
         [
            "65429.9",
            "91.78"
         ],
         [
            "65427.3",
            "1.34"
         ],
         [
            "65426.7",
            "0.01"
         ],
         [
            "65417.8",
            "0"
         ],
         [
            "65417.1",
            "14.87"
         ],
         [
            "65411.8",
            "0.01"
         ],
         [
            "65403",
            "0"
         ],
         [
            "65402.9",
            "0.04"
         ],
         [
            "65402.4",
            "23.4"
         ],
         [
            "65402.2",
            "2"
         ],
         [
            "65398.8",
            "0"
         ],
         [
            "65398.7",
            "28.46"
         ],
         [
            "65398.5",
            "36.71"
         ]
      ]
   },
   "time_ms": 1771991192205
}

{
   "time": 1771991192,
   "channel": "order_book_update",
   "event": "update",
   "result": {
      "snapshot": false,
      "ts": 1771991192182,
      "s": "GATE_FUTURE_ETH_USDT",
      "U": 89944768993,
      "u": 89944768950,
      "a": [
         [
            "1907.56",
            "10757"
         ],
         [
            "1907.61",
            "2"
         ],
         [
            "1907.66",
            "74"
         ],
         [
            "1907.91",
            "522"
         ],
         [
            "1908",
            "194"
         ],
         [
            "1911.35",
            "5174"
         ],
         [
            "1911.36",
            "2"
         ],
         [
            "1915.34",
            "1"
         ],
         [
            "1915.35",
            "18"
         ],
         [
            "1907.78",
            "0"
         ],
         [
            "1907.93",
            "0"
         ],
         [
            "1907.97",
            "0"
         ],
         [
            "1911.37",
            "0"
         ]
      ],
      "b": [
         [
            "1906.95",
            "393"
         ],
         [
            "1906.6",
            "160"
         ],
         [
            "1898.01",
            "12"
         ],
         [
            "1906.67",
            "0"
         ]
      ]
   },
   "time_ms": 1771991192213
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» snapshot	boolean	true	none	是否是快照(是可全量覆盖，否则增量更新)	Snapshot
»» ts	long	true	none	毫秒时间戳	Timestamp
»» s	string	true	none	交易对	Symbol
»» U	string	true	none	开始序列号	StartIndex
»» u	string	true	none	结束序列号	EndIndex
»» a	array	true	none	卖盘深度	[Price,Qty]
»» b	array	true	none	买盘深度	[Price,Qty]

Ticker订阅

ticker

ticker频道提供各大交易所的现货/合约的ticker推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: ticker

请求示例

{
  "event": "subscribe",
  "channel": "ticker",
  "payload": [
    "BINANCE_FUTURE_BTC_USDT"
  ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
  "time": 1770709567,
  "channel": "ticker",
  "event": "update",
  "result": {
    "s": "BINANCE_FUTURE_BTC_USDT",
    "lp": "67280.50",
    "bp": "67280.20",
    "bs": "35",
    "ap": "67280.70",
    "as": "28",
    "o": "69100.00",
    "h": "69100.00",
    "l": "66000.00",
    "v": "825432",
    "q": "5523487123.55",
    "ts": 1710001234567
  },
  "time_ms": 1770709567032
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» s	string	true	none	交易对	Symbol
»» lp	string	true	none	最新成交价	LastPrice
»» bp	string	true	none	最优买价	BidPrice
»» bs	string	true	none	最优买量	BidSize
»» ap	string	true	none	最优卖价	AskPrice
»» as	string	true	none	最优卖量	AskSize
»» o	string	true	none	24h开盘价	Open24h
»» h	string	true	none	24h最高价	High24h
»» l	string	true	none	24h最低价	Low24h
»» v	string	true	none	24h成交量(base)	Volume24h
»» q	string	false	none	24h成交量(quote)	QuoteVolume24h
»» ts	long	true	none	交易所毫秒时间戳	Timestamp

公有成交订阅

trade

trade频道提供各大交易所的现货/合约的逐笔公有成交推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: trade

请求示例

{
  "event": "subscribe",
  "channel": "trade",
  "payload": [
    "BINANCE_FUTURE_BTC_USDT"
  ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
  "time": 1770709567,
  "channel": "trade",
  "event": "update",
  "result": {
    "s": "BTCUSDT",
    "i": "18473628192",
    "p": "67250.12",
    "q": "0.015",
    "S": "BUY",
    "ts": 1710001234567,
    "m": false
  },
  "time_ms": 1770709567032
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» s	string	true	none	交易对	Symbol
»» i	string	true	none	成交ID(交易所原始格式)	TradeId
»» p	string	true	none	成交价	Price
»» q	string	true	none	成交量(base)	Quantity
»» S	string	true	none	方向	BUY/SELL
»» ts	long	true	none	交易所毫秒时间戳	Timestamp

K线订阅

kline_x

• kline_1m,kline_5m,kline_15m,kline_30m,kline_1h,kline_4h,kline_1d;

kline频道提供各大交易所的现货/合约的k线推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: kline

请求示例

{
  "channel": "kline_1m",
  "event": "subscribe",
  "payload": ["BYBIT_FUTURE_BTC_USDT", "BINANCE_FUTURE_ETH_USDT"]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
  "channel": "kline_1m",
  "event": "update",
  "result": {
    "s": "BYBIT_FUTURE_BTC_USDT",
    "o": "95000",
    "h": "95100",
    "l": "94900",
    "c": "95050",
    "v": "1234.5",
    "t": 1710000000000,
    "T": 1710000059999,
    "x": true
  }
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» s	string	true	none	交易对	Symbol
»» o	string	true	none	开盘价	OpenPrice
»» h	string	true	none	最高价	HighPrice
»» l	string	true	none	最低价	LowPrice
»» c	string	true	none	收盘价	ClosePrice
»» v	string	true	none	成交量	Volume
»» t	long	true	none	K线开始时间(毫秒)	StartTime
»» T	long	true	none	K线结束时间(毫秒)	EndTime
»» x	boolean	true	none	是否已确认(0:未完成 1:已完成)	Confirm

合约的资金费率订阅

funding_rate

funding_rate频道提供各大交易所的合约的资金费率推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: funding_rate

请求示例

{
  "event": "subscribe",
  "channel": "funding_rate",
  "payload": [
    "BINANCE_FUTURE_BTC_USDT"
  ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
  "time": 1773382659,
  "channel": "funding_rate",
  "event": "update",
  "result": {
    "s": "BINANCE_FUTURE_BTC_USDT",
    "r": "0.00002534",
    "T": 1773388800000
  },
  "time_ms": 1773382659999
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» s	string	true	none	交易对	Symbol
»» r	string	true	none	当前资金费率	FundingRate
»» T	long	true	none	下次结算毫秒时间戳	NextFundingTime

合约的持仓总量订阅

open_interest

open_interest频道提供除BINANCE外各大交易所的合约的持仓总量推送

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» payload	body	[string]	是	订阅/取消币对，暂不支持全部订阅

详细说明

» event: subscribe、unsubscribe

» channel: open_interest

请求示例

{
  "event": "subscribe",
  "channel": "open_interest",
  "payload": [
    "OKX_FUTURE_BTC_USDT"
  ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

无需认证

服务端推送

推送示例

{
  "time": 1773384822,
  "channel": "open_interest",
  "event": "update",
  "result": {
    "s": "OKX_FUTURE_BTC_USDT",
    "oi": "2929823.88000001813",
    "oiV": "29298.2388000001813"
  },
  "time_ms": 1773384822164
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» result	object	true	none	结果	none
»» s	string	true	none	交易对	Symbol
»» oi	string	true	none	持仓量	OpenInterest
»» oiV	string	false	none	持仓价值	OpenInterestValue

订单订阅/取消订阅

order

订单频道提供了一种接收用户订单更新的方式。

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	[string]	是	订阅/取消币对 !all 代表全部

详细说明

» event: subscribe、unsubscribe

» channel: order

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "order",
   "request_id": "request-1",
   "payload": [
      "GATE_FUTURE_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

需要认证

服务端推送

推送示例

{
   "channel": "order",
   "event": "subscribe",
   "payload": {
      "attribute": "COMMON",
      "business_type": "FUTURE",
      "create_time": "1756434169096",
      "exchange_type": "OKX",
      "executed_amount": "0",
      "executed_avg_price": "0",
      "executed_qty": "0",
      "fee": "0",
      "fee_coin": "",
      "last_executed_amount": "0",
      "last_executed_price": "0",
      "last_executed_qty": "0",
      "leverage": "3",
      "order_id": "2072652940337152",
      "position_side": "NONE",
      "price": "0.8499",
      "qty": "10",
      "quote_qty": "0",
      "reason": "{\"label\":\"TRADE_INSUFFICIENT_AVAILABLE_MARGIN_ERROR\",\"message\":\"Insufficient availableMargin\"}",
      "reduce_only": "false",
      "side": "BUY",
      "state": "FAIL",
      "symbol": "OKX_FUTURE_ADA_USDT",
      "text": "2072652940337152",
      "time_in_force": "GTC",
      "type": "MARKET",
      "update_time": "1756434169098",
      "user_id": "2124485957"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168968
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» payload	object	true	none	数据集	none
»» user_id	string	true	none	用户id	none
»» order_id	string	true	none	订单号	Order ID
»» text	string	true	none	客户订单号	Customer-defined order ID
»» state	string	true	none	订单状态	Order State: NEW: The order is legal and waiting to be sent to the exchange OPEN: The order has been placed on the orderbook of the exchange PARTIALLY_FILLED: The order has been partially completed FILLED: The order has been fully executed FAIL: The order verification in CrossEx did not pass. Please check the order reason REJECT：The order was rejected by the exchange. Please check the order reason
»» symbol	string	true	none	交易对	Trading pair unique identifier ,example: BINANCE_SPOT_BTC_USDT, BINANCE_FUTURE_BTC_USDT
»» side	string	true	none	方向	Side(BUY,SELL)
»» type	string	true	none	类型	Type(LIMIT, MARKET)
»» attribute	string	true	none	属性	Attribute(COMMON 普通单 / LIQ 强平接管单 / REDUCE 强平减仓单 / ADL 自动减仓 / SETTLEMENT 下架清算)
»» exchange_type	string	true	none	交易所	Exchange type(BINANCE,OKX,GATE,BYBIT,KRAKEN,HYPERLIQUID,DERIBIT)
»» business_type	string	true	none	业务类型	Business type(SPOT,FUTURE)
»» qty	string	true	none	基础货币数量	Order base quantity
»» quote_qty	string	true	none	报价币种数量	Order quote quantity
»» price	string	true	none	价格	Order price
»» time_in_force	string	true	none	Time in force 策略	Timeinforce (default GTC, enums:GTC,IOC,FOK,POC,RPI)
»» executed_qty	string	true	none	已成交数量	Executed quantity
»» executed_amount	string	true	none	已成交金额	Executed quote quantity
»» executed_avg_price	string	true	none	已成交均价	Average transaction price
»» fee_coin	string	true	none	手续费币种	Transaction fee coin
»» fee	string	true	none	手续费	Transaction fee amount
»» reduce_only	string	true	none	只减仓	Reduce position orders only, "true" or "false"
»» leverage	string	true	none	杠杆	Order leverage
»» reason	string	true	none	原因	Fail message
»» last_executed_qty	string	true	none	最新已成交量	Last transaction quantity
»» last_executed_price	string	true	none	最新已成交价	Last transaction price
»» last_executed_amount	string	true	none	最新已成交金额	Last transaction amount
»» position_side	string	true	none	仓位方向	Position side(NONE/LONG/SHORT)
»» create_time	string	true	none	创建时间	Create time
»» update_time	string	true	none	更新时间	Update time
» result	object	true	none	更新时间
»» code	string	true	none	返回码
» time	integer	true	none	时间戳（秒）
» time_ms	integer	true	none	时间戳（毫秒）

资产订阅/取消订阅

asset

资产频道提供了一种接收用户资产更新的方式。

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	[string]	是	订阅/取消币种集合 !all 代表全部

详细说明

» event: subscribe、unsubscribe

» channel: asset

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "asset",
   "request_id": "request-1",
   "payload": [
      "USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	币种列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的币种不会被覆盖。

WARNING

需要认证

服务端推送

推送示例

{
   "channel": "asset",
   "event": "subscribe",
   "payload": {
      "available_balance": "9940.013209",
      "balance": "9967.013209",
      "coin": "USDT",
      "equity": "9967.013209",
      "exchange_type": "CROSSEX",
      "futures_initial_margin": "1.236",
      "futures_maintenance_margin": "0",
      "borrowing_initial_margin": "0",
      "borrowing_maintenance_margin": "0",
      "price": "1",
      "upnl": "0",
      "user_id": "2124492766"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756465636,
   "time_ms": 1756465636463
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» payload	object	true	none	数据集	none
»» user_id	string	false	none	用户id	none
»» coin	string	false	none	币种	none
»» exchange_type	string	false	none	交易所	none
»» balance	string	false	none	余额	none
»» upnl	string	false	none	未结盈亏	none
»» equity	string	false	none	权益	none
»» futures_initial_margin	string	false	none	合约初始保证金	none
»» futures_maintenance_margin	string	false	none	合约维持保证金	none
»» borrowing_initial_margin	string	false	none	币种的借款起始保证金	none
»» borrowing_maintenance_margin	string	false	none	币种的借款维持保证金	none
»» available_balance	string	false	none	可用余额	none
» result	object	true	none	更新时间
»» code	string	true	none	返回码
» time	integer	true	none	时间戳（秒）
» time_ms	integer	true	none	时间戳（毫秒）

成交订阅/取消订阅

usertrades

成交频道提供了一种接收用户成交更新的方式。

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	[string]	是	订阅/取消币种集合 !all 代表全部

详细说明

» event: subscribe、unsubscribe

» channel: usertrades

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "usertrades",
   "request_id": "request-1",
   "payload": [
      "GATE_FUTURE_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

需要认证

服务端推送

推送示例

{
   "channel": "usertrades",
   "event": "subscribe",
   "payload": {
      "user_id": "2124492766",
      "transaction_id": "2072784922594048",
      "order_id": "2072784922592768",
      "text": "2072784922592768",
      "symbol": "GATE_SPOT_ADA_USDT",
      "exchange_type": "GATE",
      "business_type": "SPOT",
      "side": "BUY",
      "qty": "13.36",
      "price": "0.8228",
      "fee": "0.004008000000000000",
      "fee_coin": "ADA",
      "fee_rate": "0.0003",
      "match_role": "TAKER",
      "rpnl": "0",
      "position_mode": "SINGLE",
      "position_side": "",
      "create_time": "1756465636528"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168984
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» payload	object	true	none	数据集	none
»» user_id	string	false	none	用户ID	none
»» transaction_id	string	false	none	成交记录ID	none
»» order_id	string	false	none	订单ID	none
»» text	string	false	none	用户订单号	none
»» symbol	string	false	none	交易对	none
»» exchange_type	string	false	none	交易所	none
»» business_type	string	false	none	业务类型	none
»» side	string	false	none	买卖方向	none
»» qty	string	false	none	成交数量	none
»» price	string	false	none	成交价格	none
»» fee	string	false	none	手续费	none
»» fee_coin	string	false	none	手续费币种	none
»» fee_rate	string	false	none	手续费率	none
»» match_role	string	false	none	成交角色	none
»» rpnl	string	false	none	实现盈亏	none
»» position_mode	string	false	none	仓位模式	none
»» position_side	string	false	none	仓位方向	none
»» create_time	string	false	none	创建时间	none
» result	object	true	none	更新时间
»» code	string	true	none	返回码
» time	integer	true	none	时间戳（秒）
» time_ms	integer	true	none	时间戳（毫秒）

仓位订阅/取消订阅

position

仓位频道提供了一种接收用户仓位更新的方式。

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	[string]	是	!all 代表全部

详细说明

» event: subscribe、unsubscribe

» channel: position

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "position",
   "request_id": "request-1",
   "payload": [
      "GATE_FUTURE_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表，!all 表示订阅所有交易对

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

需要认证

服务端推送

推送示例

{
   "channel": "position",
   "event": "subscribe",
   "payload": {
      "create_time": "1756434169096",
      "entry_price": "0",
      "fee": "0",
      "funding_fee": "0",
      "funding_time": "0",
      "initial_margin": "0",
      "leverage": "3",
      "maintenance_margin": "0",
      "mark_price": "0.8499",
      "max_leverage": "20",
      "position_id": "20087051449819136",
      "position_qty": "0",
      "position_side": "NONE",
      "position_value": "0",
      "risk_limit": "1",
      "symbol": "OKX_FUTURE_ADA_USDT",
      "update_time": "1756434169098",
      "upnl": "0",
      "upnl_rate": "0",
      "user_id": "2124485957",
      "closed_pnl": "12"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168984
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» payload	object	true	none	数据集	none
»» user_id	string	false	none	用户id	none
»» position_id	string	false	none	仓位id	none
»» symbol	string	false	none	交易对	none
»» position_side	string	false	none	仓位方向	none
»» initial_margin	string	false	none	初始保证金	none
»» maintenance_margin	string	false	none	维持保证金	none
»» position_qty	string	false	none	仓位数量	none
»» position_value	string	false	none	仓位价值	none
»» upnl	string	false	none	未结盈亏	none
»» upnl_rate	string	false	none	未结盈亏比	none
»» entry_price	string	false	none	仓位入场均价	none
»» mark_price	string	false	none	标记价格	none
»» leverage	string	false	none	仓位杠杆	none
»» max_leverage	string	false	none	最大杠杆	none
»» risk_limit	string	false	none	风险限额	none
»» fee	string	false	none	仓位手续费	none
»» funding_fee	string	false	none	仓位资金费	none
»» funding_time	string	false	none	仓位资金费收取时间	none
»» create_time	string	false	none	仓位创建时间	none
»» update_time	string	false	none	仓位更新时间	none
»» closed_pnl	string	false	none	已结盈亏	none
» result	object	true	none	更新时间
»» code	string	true	none	返回码
» time	integer	true	none	时间戳（秒）
» time_ms	integer	true	none	时间戳（毫秒）

杠杆仓位订阅/取消订阅

margin_position

杠杆仓位频道提供了一种接收用户杠杆仓位更新的方式。

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	[string]	是	!all 代表全部

详细说明

» event: subscribe、unsubscribe

» channel: margin_position

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "margin_position",
   "request_id": "request-1",
   "payload": [
      "GATE_MARGIN_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表，!all 表示订阅所有交易对

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

需要认证

服务端推送

推送示例

{
   "channel": "margin_position",
   "event": "subscribe",
   "payload": {
      "user_id": "20251115",
      "position_id": "20116122196200192",
      "symbol": "OKX_MARGIN_DOGE_USDT",
      "position_side": "LONG",
      "initial_margin": "3.339831063595188875",
      "maintenance_margin": "0.20743774877",
      "asset_qty": "61.72130605",
      "asset_coin": "DOGE",
      "position_value": "9.9969999409185",
      "liability": "10.00003424116",
      "liability_coin": "USDT",
      "interest": "0.0000343",
      "max_position_qty": "61.72130605",
      "entry_price": "0.162018605585874506",
      "index_price": "0.16197",
      "upnl": "-0.0030343002415",
      "upnl_rate": "-0.000909",
      "leverage": "3",
      "max_leverage": "8",
      "create_time": "1763365175843",
      "update_time": "1763365689548"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168984
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» payload	object	true	none	数据集	none
»» user_id	string	false	none	用户id	none
»» position_id	string	false	none	仓位id	none
»» symbol	string	false	none	交易币对EXCHANGE_MARGIN_BASE_COUNTER	none
»» position_side	string	false	none	仓位方向	none
»» initial_margin	string	false	none	仓位初始保证金	none
»» maintenance_margin	string	false	none	仓位维持保证金	none
»» asset_qty	string	false	none	仓位资产数量	none
»» asset_coin	string	false	none	仓位资产币种	none
»» position_value	string	false	none	仓位价值	none
»» liability	string	false	none	负债数量	none
»» liability_coin	string	false	none	负债币种	none
»» interest	string	false	none	已扣利息	none
»» max_position_qty	string	false	none	最大持仓量	none
»» entry_price	string	false	none	持仓成本价(开仓均价)	none
»» index_price	string	false	none	指数价格	none
»» upnl	string	false	none	未结盈亏	none
»» upnl_rate	string	false	none	未结盈亏比	none
»» leverage	string	false	none	开仓杠杆	none
»» max_leverage	string	false	none	最大杠杆	none
»» create_time	string	false	none	创建时间	none
»» update_time	string	false	none	更新时间	none
» result	object	true	none	更新时间
»» code	string	true	none	返回码
» time	integer	true	none	时间戳（秒）
» time_ms	integer	true	none	时间戳（毫秒）

杠杆利息订阅/取消订阅

margin_interest

杠杆利息频道提供了一种接收用户杠杆利息更新的方式。

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	[string]	是	!all 代表全部

详细说明

» event: subscribe、unsubscribe

» channel: margin_interest

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "margin_interest",
   "request_id": "request-1",
   "payload": [
      "GATE_MARGIN_ETH_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表，!all 表示订阅所有交易对

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

需要认证

服务端推送

推送示例

{
   "channel": "margin_interest",
   "event": "subscribe",
   "payload": {
      "user_id": "20251115",
      "symbol": "OKX_MARGIN_DOGE_USDT",
      "interest_id": "2101724189861376",
      "liability_id": "2101724189861120",
      "liability": "10",
      "liability_coin": "USDT",
      "interest": "0.0000343",
      "interest_rate": "0.00000343",
      "interest_type": "IMMEDIATE_OPEN_ORDER",
      "create_time": "1763365295219"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168984
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» payload	object	true	none	数据集	none
»» user_id	string	false	none	用户id	none
»» symbol	string	false	none	交易对	none
»» interest_id	string	false	none	扣息Id	none
»» liability_id	string	false	none	负债源id 可以是订单Id/仓位Id	none
»» liability	string	false	none	负债	none
»» liability_coin	string	false	none	币种	none
»» interest	string	false	none	利息	none
»» interest_rate	string	false	none	利率	none
»» interest_type	string	false	none	扣息类型	none
»» create_time	string	false	none	仓位创建时间	none
» result	object	true	none	更新时间
»» code	string	true	none	返回码
» time	integer	true	none	时间戳（秒）
» time_ms	integer	true	none	时间戳（毫秒）

详细说明

» interest_type: 扣息类型 PERIODIC_POSITION整点仓位收息、PERIODIC_OPEN_ORDER整点挂单收息、IMMEDIATE_OPEN_ORDER开单收息

ADL排名订阅/取消订阅

adl_rank

ADL排名频道提供了一种接收用户ADL排名更新的方式。

推送类型: continuous

更新频率: real-time

客户端订阅

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	[string]	是	!all 代表全部

详细说明

» event: subscribe、unsubscribe

» channel: adl_rank

请求示例

{
   "time": 1754272114,
   "event": "subscribe",
   "channel": "adl_rank",
   "request_id": "request-1",
   "payload": [
      "BINANCE_FUTURE_ADA_USDT"
   ]
}

格式:

名称	类型	必选	描述
payload	Array[String]	是	交易对列表，!all 表示订阅所有交易对

您可以多次订阅/取消订阅。除非明确取消订阅，否则之前订阅的交易对不会被覆盖。

WARNING

需要认证

服务端推送

推送示例

{
   "channel": "adl_rank",
   "event": "subscribe",
   "payload": {
      "user_id": "20251115",
      "symbol": "BINANCE_FUTURE_ADA_USDT",
      "crossex_adl_rank": "1",
      "exchange_adl_rank": "1"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168984
}

推送参数:

名称	类型	必选	约束	释义	说明
» channel	string	true	none	频道名	none
» event	string	true	none	事件	none
» payload	object	true	none	数据集	none
»» user_id	string	false	none	用户id	none
»» symbol	string	false	none	交易对	none
»» crossex_adl_rank	string	false	none	CrossEx ADL排名	1-5，数字越大排名越前
»» exchange_adl_rank	string	false	none	交易所原始ADL排名	Binance：0-4，数字越大越靠前；OKX：0-5，数字越大越靠前；Gate：1-5，数字越小越靠前；Kraken：20,40,80,100，数字越小越靠前
» result	object	true	none	更新时间
»» code	string	true	none	返回码
» time	integer	true	none	时间戳（秒）
» time_ms	integer	true	none	时间戳（毫秒）

下单

place_order

提供了一种通过 WebSocket 下单的方式。

限频: 每10秒100次请求（同REST下单共享限频）

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	none
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	object	是	none
»» header	body	object	否	请求头信息
»»» X-Gate-Channel-Id	body	string	否	broker返佣渠道id
»» text	body	string¦null	否	用户自定义id
»» symbol	body	string	是	唯一标识符：Exchange_Business_Base_Counter
»» side	body	string	是	交易方向
»» qty	body	string¦null	否	交易币种数量
»» price	body	string¦null	否	价格
»» type	body	string¦null	否	订单类型（默认LIMIT，支持类型列举：LIMIT、MARKET）
»» time_in_force	body	string¦null	否	执行方式
»» quote_qty	body	string¦null	否	报价币种数量
»» reduce_only	body	boolean¦null	否	只减仓
»» position_side	body	string¦null	否	仓位方向

详细说明

» event: api

» channel: place_order

»» text: 用户自定义id 客户定义的订单ID，仅支持字母（a-z）、数字（0-9）、符号（-，_）

»» symbol: 唯一标识符：Exchange_Business_Base_Counter 示例：

• 如果您想在BINANCE交易所上为ADA/USDT交易对下现货订单，您可以使用这样的唯一标识符：BINANCE_SPOT_ADA_USDT;
• 如果您想在OKX交易所上为ADA/USDT交易对下U本位永续合约订单，您可以使用这样的唯一标识符：OKX_FUTURE_ADA_USDT;
• 如果您想在GATE交易所上为ADA/USDT交易对下现货杠杆订单，您可以使用这样的唯一标识符：GATE_MARGIN_ADA_USDT;
• 如果您想在BYBIT交易所上为ADA/USDT交易对下现货订单，您可以使用这样的唯一标识符：BYBIT_SPOT_ADA_USDT;
• 如果您想在KRAKEN交易所上为ADA/USD交易对下合约订单，您可以使用这样的唯一标识符：KRAKEN_FUTURE_ADA_USD;
• 如果您想在HYPERLIQUID交易所上为ADA/USDC交易对下合约订单，您可以使用这样的唯一标识符：HYPERLIQUID_FUTURE_ADA_USDC;
• 如果您想在DERIBIT交易所上为ADA/USDC交易对下合约订单，您可以使用这样的唯一标识符：DERIBIT_FUTURE_ADA_USDC;
• 目前支持三种订单：现货订单、U本位永续合约订单和现货杠杆订单, BYBIT、DERIBIT暂不支持现货杠杆订单, KRAKEN、HYPERLIQUID暂不支持现货与杠杆订单

»» side: 买 BUY 卖 SELL

»» qty: 交易币种数量 订单数量（强制性，除非现货市场买入）

»» price: 价格 限价订单价格（限价订单必须）

»» time_in_force: 执行方式 默认GTC，支持类型枚举：GTC，IOC，FOK，POC，RPI

»» quote_qty: 报价币种数量 订单报价数量，仅用于现货市场买入订单

»» reduce_only: 只减仓 true、false

»» position_side: 仓位方向 不传单仓。LONG, SHORT 枚举值: LONG SHORT NONE

请求示例

{
   "time": 1754272114,
   "event": "api",
   "channel": "place_order",
   "request_id": "request-1",
   "payload": {
     "header":{
       "X-Gate-Channel-Id":"broker-api"
      },
      "text": "test1",
      "symbol": "GATE_FUTURE_ETH_USDT",
      "side": "BUY",
      "qty": "0.01",
      "price": "2800",
      "type": "LIMIT"
   }
}

返回结果

名称	类型	必选	约束	释义	说明
» channel	string	true	none		频道名 place_order
» event	string	true	none		事件 api
» request_id	string	false	none		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	object	true	none		下单请求参数
»» order_id	string	true	none		订单号
»» text	string	true	none		客户端ID
» result	object	true	none		下单结果
»» code	string	true	none		none
»» message	string	true	none		none
» time	integer	true	none		时间戳（秒）
» time_ms	integer	true	none		时间戳（毫秒）

返回示例

{
   "channel": "place_order",
   "event": "api",
   "request_id": "request-1",
   "payload": {
      "order_id": "2072652940337152",
      "text": "2072652940337152"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168948
}

取消订单

cancel_order

提供了一种通过 WebSocket 取消订单的方式。

限频: 每10秒100次请求（同REST下单共享限频）

客户端请求

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	通道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	string	是	订单号(支持订单id或text)

详细说明

» event: api

» channel: cancel_order

请求示例

{
   "time": 1754272114,
   "event": "api",
   "channel": "cancel_order",
   "request_id": "request-1",
   "payload": "2065058175870464"
}

返回结果

名称	类型	必选	约束	释义	说明
» channel	string	true	none		通道名 cancel_order
» event	string	true	none		事件 api
» request_id	string	false	none		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» result	object	true	none		取消订单结果
»» code	string	true	none		响应码
»» message	string	true	none		响应信息
» time	integer	true	none		时间戳（秒）
» time_ms	integer	true	none		时间戳（毫秒）

返回示例

{
   "channel": "cancel_order",
   "event": "api",
   "request_id": "request-1",
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168948
}

批量取消订单

batch_cancel_orders

提供了一种通过 WebSocket 批量取消订单的方式。每个订单可使用订单 ID 或用户自定义 ID 撤销；两者同时传入时优先使用订单 ID。

限频: 每10秒100次请求（同 REST 撤单共享限频）

客户端请求

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	通道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	array	是	待撤销的订单列表
»» order_id	body	string	否	订单 ID，与 text 必传其一
»» text	body	string	否	用户创建订单时指定的自定义 ID，与 order_id 必传其一

详细说明

» event: api

» channel: batch_cancel_orders

请求示例

{
   "time": 1754272114,
   "event": "api",
   "channel": "batch_cancel_orders",
   "request_id": "request-1",
   "payload": [
      {
         "order_id": "2065058175870464"
      },
      {
         "text": "crossex-test-1"
      }
   ]
}

返回结果

名称	类型	必选	约束	释义	说明
» channel	string	true	none		通道名 batch_cancel_orders
» event	string	true	none		事件 api
» request_id	string	false	none		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	array	true	none		批量撤单请求处理结果
»» order_id	string	true	none		订单 ID
»» text	string	true	none		用户创建订单时指定的自定义 ID
»» accepted	string	true	none		是否受理成功，字符串 true 或 false
»» label	string	true	none		受理失败时的错误标识，成功时为空
»» message	string	true	none		受理失败时的错误信息，成功时为空
» result	object	true	none		接口调用结果
»» code	string	true	none		响应码
»» message	string	true	none		响应信息
» time	integer	true	none		时间戳（秒）
» time_ms	integer	true	none		时间戳（毫秒）

返回示例

{
   "channel": "batch_cancel_orders",
   "event": "api",
   "request_id": "request-1",
   "payload": [
      {
         "order_id": "2065058175870464",
         "text": "crossex-test-1",
         "accepted": "true",
         "label": "",
         "message": ""
      },
      {
         "order_id": "999999",
         "text": "",
         "accepted": "false",
         "label": "TRADE_ORDER_NOT_FOUND_ERROR",
         "message": "The order was not found"
      }
   ],
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168948
}

修改订单

update_order

提供了一种通过 WebSocket 修改订单的方式。

限频: 每10秒100次请求（同REST下单共享限频）

客户端请求

请求参数

名称	位置	类型	必选	释义	说明
» time	body	integer	是		时间戳（秒）
» event	body	string	是		事件
» channel	body	string	是		通道名
» request_id	body	string	否		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	object	是		none
»» order_id	body	string	是	订单ID	支持订单id或text
»» qty	body	string	是	数量	none
»» price	body	string	是		none
»» symbol	body	string	否		none

详细说明

» event: api

» channel: update_order

请求示例

{
   "time": 1754272114,
   "event": "api",
   "channel": "update_order",
   "request_id": "request-1",
   "payload": {
      "order_id": "2065057827622656",
      "qty": "0.01",
      "symbol": "GATE_SPOT_BTC_USDT",
      "price": "2801"
   }
}

返回结果

名称	类型	必选	约束	释义	说明
» channel	string	true	none		通道名 update_order
» event	string	true	none		事件 api
» request_id	string	false	none		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	object	true	none		none
»» order_id	string	true	none		订单ID
»» text	string	true	none		客户端ID
» result	object	true	none		修改结果
»» code	string	true	none		响应码
»» message	string	true	none		响应消息
» time	integer	true	none		时间戳（秒）
» time_ms	integer	true	none		时间戳（毫秒）

返回示例

{
   "channel": "update_order",
   "event": "api",
   "request_id": "request-1",
   "payload": {
      "order_id": "2072652940337152",
      "text": "2072652940337152"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168948
}

修改合约的杠杆倍数

set_leverage

提供了一种通过 WebSocket 修改合约杠杆倍数的方式。

限频: 每10秒100次请求（同REST下单共享限频）

客户端请求

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	object	是	none
»» symbol	body	string	是	币对
»» leverage	body	string	是	倍数

详细说明

» event: api

» channel: set_leverage

请求示例

{
   "time": 1754272114,
   "event": "api",
   "channel": "set_leverage",
   "request_id": "request-1",
   "payload": {
      "symbol": "GATE_FUTURE_ETH_USDT",
      "leverage": "5"
   }
}

返回结果

名称	类型	必选	约束	释义	说明
» channel	string	true	none		频道名 set_leverage
» event	string	true	none		事件 api
» request_id	string	false	none		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	object	true	none		none
»» symbol	string	true	none		币对
»» leverage	string	true	none		倍数
» result	object	true	none		修改结果
»» code	string	true	none		响应码
»» message	string	true	none		响应消息
» time	integer	true	none		时间戳（秒）
» time_ms	integer	true	none		时间戳（毫秒）

返回示例

{
   "channel": "set_leverage",
   "event": "api",
   "request_id": "request-1",
   "payload": {
      "symbol": "GATE_FUTURE_ETH_USDT",
      "leverage": "10"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168948
}

修改现货杠杆的杠杆倍数

set_margin_leverage

提供了一种通过 WebSocket 修改现货杠杆倍数的方式。

限频: 每10秒100次请求（同REST下单共享限频）

客户端请求

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	object	是	none
»» symbol	body	string	是	币对
»» leverage	body	string	是	倍数

详细说明

» event: api

» channel: set_margin_leverage

请求示例

{
   "time": 1754272114,
   "event": "api",
   "channel": "set_margin_leverage",
   "request_id": "request-1",
   "payload": {
      "symbol": "OKX_MARGIN_ADA_USDT",
      "leverage": "5"
   }
}

返回结果

名称	类型	必选	约束	释义	说明
» channel	string	true	none		频道名 set_leverage
» event	string	true	none		事件 api
» request_id	string	false	none		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	object	true	none		none
»» symbol	string	true	none		币对
»» leverage	string	true	none		倍数
» result	object	true	none		修改结果
»» code	string	true	none		响应码
»» message	string	true	none		响应消息
» time	integer	true	none		时间戳（秒）
» time_ms	integer	true	none		时间戳（毫秒）

返回示例

{
   "channel": "set_margin_leverage",
   "event": "api",
   "request_id": "request-1",
   "payload": {
      "symbol": "OKX_MARGIN_ADA_USDT",
      "leverage": "10"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168948
}

更改账户合约仓位模式和账户模式

update_accounts

提供了一种通过 WebSocket 更改账户合约仓位模式和账户模式的方式。

每60秒100次请求

客户端请求

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	object	是	none
»» position_mode	body	string	否	仓位模式
»» account_mode	body	string	否	账户模式
»» exchange_type	body	string	否	交易所，默认还是跨所

详细说明

» event: api

» channel: update_accounts

»» position_mode: SINGLE/DUAL

»» account_mode: CROSS_EXCHANGE/ISOLATED_EXCHANGE

»» exchange_type: BINANCE/OKX/GATE/BYBIT/KRAKEN/HYPERLIQUID/DERIBIT/CROSSEX，当账户模式为ISOLATED_EXCHANGE时，修改合约仓位模式必须指定交易所

请求参数

{
   "time": 1754272114,
   "event": "api",
   "channel": "update_accounts",
   "request_id": "request-1",
   "payload": {
      "account_mode":"ISOLATED_EXCHANGE",
      "position_mode": "DUAL",
      "exchange_type": "BINANCE"
   }
}

返回结果

名称	类型	必选	约束	释义	说明
» channel	string	true	none		频道名 update_accounts
» event	string	true	none		事件 api
» request_id	string	false	none		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	object	true	none		none
»» position_mode	string	false	none		仓位模式
»» account_mode	string	false	none		账户模式
»» exchange_type	string	false	none		交易所
» result	object	true	none		修改结果
»» code	string	true	none		响应码
»» message	string	true	none		响应信息
» time	integer	true	none		时间戳（秒）
» time_ms	integer	true	none		时间戳（毫秒）

返回示例

{
   "channel": "update_accounts",
   "event": "api",
   "request_id": "request-1",
   "payload": {
      "account_mode":"ISOLATED_EXCHANGE",
      "position_mode": "DUAL",
      "exchange_type": "BINANCE"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168948
}

完全平仓

close_position

提供了一种通过 WebSocket 完全平仓的方式。

每天100次请求

客户端请求

请求参数

名称	位置	类型	必选	说明
» time	body	integer	是	时间戳（秒）
» event	body	string	是	事件
» channel	body	string	是	频道名
» request_id	body	string	否	请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	body	object	是	none
»» symbol	body	string	是	币对
»» position_side	body	string	否	仓位方向

详细说明

» event: api

» channel: close_position

请求示例

{
   "time": 1754272114,
   "event": "api",
   "channel": "close_position",
   "request_id": "request-1",
   "payload": {
      "symbol": "GATE_MARGIN_ETH_USDT",
      "position_side": "LONG"
   }
}

返回结果

名称	类型	必选	约束	释义	说明
» channel	string	true	none		频道名 close_position
» event	string	true	none		事件 api
» request_id	string	false	none		请求 id，服务器会发回，帮助你识别服务器响应的是哪个请求
» payload	object	true	none		none
»» order_id	string	true	none		订单号
»» text	string	true	none		客户端ID

返回示例

{
   "channel": "close_position",
   "event": "api",
   "request_id": "request-1",
   "payload": {
      "order_id": "2072652940337152",
      "text": "2072652940337152"
   },
   "result": {
      "code": "100000",
      "message": "success"
   },
   "time": 1756434168,
   "time_ms": 1756434168948
}

返回码

返回码	说明
100000	成功
100001	参数丢失或无效
100002	未登陆
100003	连接达到最大数
100004	超时
100005	操作失败
100006	登陆失败
100007	网络错误，请稍后再试