跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://developer.wooxpro.com/llms.txt

Use this file to discover all available pages before exploring further.

​
指令格式

客户端发送给WOO X Pro服务器的消息格式。 {"action":"<operation>", "args":["<topic1>","<topic2>"]} 解释:
  • operation 请求动作, 取值:[subscribe=订阅, unsubscribe=取消订阅, login=登录]
  • args 请求参数，取值: 频道数组或者登录需要的参数
  • topic 频道主题，由<channel>:<filter>组成
    • channel 是以 business/name组成
    • filter 是可筛选数据，具体参考每个频道说明
示例:
  • 示例1：{"action": "subscribe", "args": ["futures/depth50:BTCUSDT"]}
    • 表示订阅表示合约交易对BTCUSDT的深度数据
  • 示例2：{"action": "login", "args": ["80618e45710812162b04892c7ee5ead4a3cc3e56", "1589267764859", "3ceeb7e1b8cb165a975e28a2e2dfaca4d30b358873c0351c1a071d8c83314556", "web"]}
    • 进行私人频道订阅之前的登录请求

​
成功响应格式

WOO X Pro服务器向客户端返回成功消息的格式。 返回success字段为ture
成功响应格式 
当 action=access 时：
{"action":"access","success":true}

当 action=unsubscribe 时：
{"action":"unsubscribe","group":"futures/depth50:BTCUSDT","success":true,"request":{"action":"unsubscribe","args":["futures/depth50:BTCUSDT"]}}

当 action=subscribe 时：
{"action":"subscribe","group":"futures/depth50:BTCUSDT","success":true,"request":{"action":"subscribe","args":["futures/depth50:BTCUSDT"]}}
示例:
  • 示例1：{"action":"access","success":true}
    • 表示登录成功
  • 示例2：{"action":"unsubscribe","group":"futures/depth50:BTCUSDT","success":true,"request":{"action":"unsubscribe","args":["futures/depth50:BTCUSDT"]}}
    • 表示取消合约交易对BTCUSDT的深度50订阅成功
  • 示例3：{"action":"subscribe","group":"futures/depth50:BTCUSDT","success":true,"request":{"action":"subscribe","args":["futures/depth50:BTCUSDT"]}}
    • 表示现货交易对BTCUSDT的深度50订阅成功
  • 示例4：{"group":"futures/depth50:BTCUSDT","data":{"symbol":"BTCUSDT","way":2,"depths":[{"price":"30107.7","vol":"234"},{"price":"30107.8","vol":"1587"}]}}
    • 表示现货交易对BTCUSDT的深度50订阅返回数据

​
失败响应格式

WOO X Pro服务器向客户端返回失败消息的格式。 返回 success 字段为 false
失败响应格式 
{"action":"subscribe","group":"futures/depth50:BTCUSDT","success":false,"error":"authentication is temporarily unavailable"}
  • 示例1：{"action":"subscribe","group":"futures/order","success":false,"error":"futures/order need authenication"}
    • 表示您的订阅需要先登陆
  • 示例2：{"action":"access","success":false,"error":"access failed: openapi auth: apiKey 880d5edecs**** failed: openapi auth failed"}
    • 表示登录失败,您的签名不通过
  • 示例3：{"action":"subscribe","group":"sfutures/depth50:BTCUSDT","success":false,"request":{"action":"subscribe","args":["sfutures/depth50:BTCUSDT"]},"error":"group [sfutures/depth50:BTCUSDT] not exist"}
    • 表示订阅失败，您的参数是无效的，不存在这个频道