跳到主要内容

订阅持仓模式

API说明​

此Websocket提供持仓模式（逐仓或全仓）和持仓布局（合并或分开持仓）的实时更新，使用户能够有效管理其交易策略。

注意：持仓模式可通过RESTful和Websocket接口获取。本页是Websocket接口的描述。如需了解RESTful接口，请参见 跳转

注意事项​

  1. 除非在建立连接后持仓模式或持仓布局发生变化，否则Websocket不会返回数据。如果没有变化发生，将不会发送更新。

认证​

这是一个私有Websocket，需要认证。有关使用Websocket API的详细信息，请参考简介 > 认证和代码示例 > 合约 > Websocket私有接口。

Websocket URL​

wss://ws.futurescw.com/perpum

频率限制​

此订阅的频率限制为每IP每秒3个请求。

订阅参数​

参数必填类型描述
eventtrueString订阅或取消订阅。sub：订阅；unsub：取消订阅。注意：此参数区分大小写。
paramstrueJson包含以下内容的数据对象：
-biztrueString指定频道，例如"futures"。
-typetrueString定义功能类型，例如"user_setting"。

响应参数​

参数类型描述
bizString指定频道，例如"futures"。
typeString定义功能类型，例如"user_setting"。
resultboolean表示订阅或取消订阅是否成功：true, false。
channelString指定执行的操作：subscribe或unsubscribe。
-layoutInteger持仓布局：0：合并持仓，1：分开持仓
-positionModelInteger持仓持仓模式：0：逐仓，1：全仓
-userIdLong合约账户用户ID

订阅示例​

以下Python代码展示了如何检查持仓布局和持仓持仓模式。

注意：完整代码示例请参考简介 > 认证和代码示例 > 合约 > Websocket私有接口。

url = "wss://ws.futurescw.com/perpum"
subscription_payload = {"event": "sub",
                         "params": {"biz": "futures",
                                    "type": "user_setting"}}
api_key= "your_api_key" 
sec_key = "your_sec_key"

FuturesWebsocketPrivate(url, api_key, sec_key, subscription_payload) # function FuturesWebsocketPrivate() is defined in section (Introduction > Authentication & Code Snippet > Futures > Websocket Private Interface)

注意：完整Java代码示例请参考简介 > 认证和代码示例 > 合约 > Websocket私有接口。

响应示例​

以下是上述Python订阅返回的示例响应，它会实时更新：

{'biz': 'futures',
 'data': {'result': True},
 'channel': 'subscribe',
 'type': 'user_setting'}
{'biz': 'futures',
 'data': [{'layout': 1, 'positionModel': 1, 'userId': 600001359}],
 'type': 'user_setting'}.....