协议总览
连接与鉴权
| 项目 | 规范 |
|---|---|
| 连接 URL | wss://api.rtick.io/ws?apiKey={apiKey} |
| 通信协议 | WSS(WebSocket over TLS)/ WS |
| 数据格式 | UTF-8 编码的 JSON 文本帧(Text Frame) |
| 网络压缩 | 支持 permessage-deflate 扩展协商,可降低 70%~80% 实时广播带宽 |
| 鉴权方式 | 握手时 Query 参数携带 apiKey;无效 / 过期下发 code=401 控制帧后主动关闭连接 |
| 并发限制 | 单 apiKey 默认最大 5 条并发长连接(可随套餐扩容) |
| 批量限制 | 单次订阅 / 退订最多 200 只产品,超出请分批次 |
报文事件类型(event)枚举
所有下发消息帧外层均含 event(int32 纯整数枚举),便于客户端高效率分流路由:
| event 值 | 含义 | 方向 | 说明 |
|---|---|---|---|
0 |
系统与控制帧 | 服务端 → 客户端 | 订阅应答、退订应答、心跳 Pong 应答、错误预警通知 |
1 |
K 线推送 | 服务端 → 客户端 | 多产品、多周期 K 线增量推送(载荷置于 data) |
2 |
Tick 逐笔推送 | 服务端 → 客户端 | 多产品逐笔成交推送(载荷置于 data) |
3 |
盘口深度推送 | 服务端 → 客户端 | 多产品买卖档位变动推送(载荷置于 data) |
4 |
分时走势推送 | 服务端 → 客户端 | 多产品分时点增量推送(载荷置于 data) |
连接生命周期
客户端 (Client) 网关服务端 (Gateway)
| |
|--- 1. 建立 WSS 连接 (带 apiKey) --->|
|<-- 2. 握手成功 (101 Switching) ----|
|--- 3. 订阅 {"action":"sub",...} ->|
|<-- 4. 订阅成功 {"event":0,...} ---|
|<-- 5. 持续下发行情 (event 1~4) ---|
|--- 6. 每 30 秒发送心跳 (ping) --->|
|<-- 7. 立即应答 (pong+server_time)-|