跳转到主要内容
WSS

概述

TickFlow 提供两个 WebSocket 接口:
WebSocket 为付费功能,需要订阅包含 WebSocket 实时行情的套餐(如 Expert)或单独开启。市场深度频道额外需要「市场深度」权限。

统一推送 /v1/ws/stream

连接地址

通过 api_key 查询参数认证。认证失败返回 HTTP 401/403,客户端应停止重连 所有消息使用 JSON 文本帧。

客户端命令

subscribe — 订阅频道

频道channel)+ 标的列表symbols)订阅。可多次调用追加。
服务端返回该频道的 subscribed 确认,并立即推送新增标的的缓存快照。 支持的频道:

unsubscribe — 退订频道

服务端消息

subscribed — 频道订阅状态

quotes — 行情推送

depth — 市场深度推送

error — 错误消息

常见错误:
  • no permission for channel: ... — 无该频道权限
  • unknown channel: ... — 未知频道名
  • exceeded max N symbols — 标的数超出套餐上限
  • invalid message: ... — JSON 格式不正确

命令总览


行情推送 /v1/ws/quotes(旧版)

旧版接口仅推送行情数据,不支持市场深度。新接入建议使用 /v1/ws/stream

连接地址

协议

与统一推送的 quotes 频道行为一致,但不使用 channel 字段:
服务端推送 quotessubscribederror 消息,格式与统一推送相同。

连接保活

服务端每 30 秒发送一次 Ping 帧,客户端需回复 Pong 帧。大多数 WebSocket 库会自动处理。

连接管理

  • 断开清理:连接断开后该连接的所有订阅自动清除
  • 重连恢复:客户端断线重连后需重新发送 subscribe 恢复订阅
  • 认证错误:收到 HTTP 401/403 时不应自动重连,请检查 API Key 和套餐权限

代码示例

使用 websockets 库连接统一推送:
如果只需获取某一时刻的行情快照,使用 REST 接口更为简单。WebSocket 适合需要持续接收行情更新的场景。
api_key
type:httpApiKey
订阅频道
type:object

按频道和标的列表订阅,订阅成功后推送缓存快照

退订频道
type:object

按频道退订指定标的

频道订阅状态
type:object

subscribe / unsubscribe 操作后返回该频道的完整订阅列表

行情推送
type:object

实时行情数据,仅包含已订阅且有更新的标的

市场深度推送
type:object

五档盘口数据,仅包含已订阅 depth 频道且有更新的标的

错误消息
type:object

操作失败时返回的错误信息