订阅当前订单
API说明
此Websocket允许用户 订阅所有当前订单的实时更新,包括市价单和限价单。
注意:当前订单数据可通过RESTful和Websocket接口获取。本页是Websocket接口的描述。如需了解RESTful接口,请参见 跳转
注意事项
- 除非下了新订单或订单状态发生变化,否则Websocket连接不会返回任何响应。如果没有变化发生,Websocket将不会提供更新。用户应确保有活跃的交易活动以接收实时更新。
- 对于市价单,响应中的"side"参数将返回空字符串。
认证
这是一个私有接口,需要认证。有关使用Websocket API的详细信息,请参考简介 > 认证和代码示例 > 现货 > Websocket私有接口。
Websocket URL
频率限制
无
订阅参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| event | true | String | 订阅或取消订阅。sub:订阅;unsub:取消订阅。 注意:此参数区分大小写。 |
| params | true | Json | 包含以下内容的数据对象: |
| -biz | true | String | 指定频道,例如"exchange" |
| -type | true | String | 定义功能类型,例如"order" |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| biz | String | 指定频道,例如"exchange" |
| type | String | 定义功能类型,例如"order" |
| data | Array | 数据对象 |
| -fee | String | 手续费 |
| -dealFunds | String | 订单金额 |
| -type | String | 订单成功:Done |
| -time | Long | 订单时间(时间戳) |
| -product_id | String | 交易品种,例如BTC-USDT |
| -order_id | String | 订单ID |
| -client_id | String | 用户分配的自定义订单ID |
| -size | String | 以基础货币计的订单大小 |
| -remaining_size | String | 以基础货币计的剩余订单大小 |
| -price | String | 用户指定的订单价格:注意:对于市价单,它代表市场价格。 |
| -side | String | 交易方向:BUY/SELL |
| -order_type | String | 订单类型:LIMIT - 限价,MARKET - 市价 |
| -reason | String | 原因:Cancelled/Filled |
| -dealAvgPrice | String | 平均价格 |
订阅示例
以下Python代码展示了如何订阅当前订单。
注意:完整代码示例请参考简介 > 认证和代码示例 > 现货 > Websocket私有接口。
url = "wss://ws.futurescw.com"
subscription_payload = {"event": "sub",
"params": {"biz": "exchange",
"type": "order"}}
api_key= "your_api_key"
sec_key = "your_sec_key"
SpotWebsocketPrivate(url, subscription_payload, api_key, sec_key) # 函数SpotwWebsocketPrivate()在章节(简介 > 认证和代码示例 > 现货 > Websocket私有接口)中定义
注意:完整Java代码示例请参考简介 > 认证和代码示例 > 现货 > Websocket私有接口。
响应示例
以下是上述Python订阅返回的示例响应。Websocket订阅将实时更新当前订单。为简洁起见,下面仅提供一个订单信息:
{'data': {'result': True}, 'channel': 'login'}
{'biz': 'exchange', 'data': {'result': True}, 'channel': 'subscribe', 'type': 'order'}
{'biz': 'exchange',
'data': {'side': 'BUY',
'fee': '0',
'dealFunds': '0',
'type': 'RECEIVED',
'client_id': 'you*******',
'remaining_size': '0.0001',
'size': '0.0001',
'price': '82000',
'product_id': 'BTC_USDT',
'time': 1743244437255,
'order_id': 4624530513294751114,
'order_type': 'LIMIT'},
'type': 'order'},.....