tickplus 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tickplus/SKILL.md +484 -0
- tickplus/__init__.py +0 -0
- tickplus/references/apidoc.md +1228 -0
- tickplus/references/websocket.md +722 -0
- tickplus/scripts/CompleteExampleClient.py +139 -0
- tickplus/scripts/Config.py +3 -0
- tickplus/scripts/StockApiClient.py +121 -0
- tickplus/scripts/StockWebSocketClient.py +197 -0
- tickplus/scripts/__init__.py +0 -0
- tickplus/scripts/api/BasicApi.py +152 -0
- tickplus/scripts/api/ExpertApi.py +78 -0
- tickplus/scripts/api/ProApi.py +110 -0
- tickplus/scripts/generate_apidoc.py +112 -0
- tickplus/scripts/util/DataUtil.py +67 -0
- tickplus-0.1.0.dist-info/METADATA +443 -0
- tickplus-0.1.0.dist-info/RECORD +18 -0
- tickplus-0.1.0.dist-info/WHEEL +5 -0
- tickplus-0.1.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,722 @@
|
|
|
1
|
+
# TickPlus WebSocket 实时数据接入指南
|
|
2
|
+
|
|
3
|
+
## 概述
|
|
4
|
+
|
|
5
|
+
TickPlus 平台提供 WebSocket 实时数据推送服务,允许用户订阅股票行情、集合竞价等实时金融数据。通过 WebSocket 长连接,您可以获得秒级的数据更新,无需频繁轮询 API。
|
|
6
|
+
|
|
7
|
+
## 前置条件
|
|
8
|
+
|
|
9
|
+
1. **注册账号**:在 [TickPlus官网](http://www.tickplus.org) 注册并获取 Token
|
|
10
|
+
2. **安装依赖**:确保已安装 `websocket-client` 库
|
|
11
|
+
```bash
|
|
12
|
+
pip install websocket-client
|
|
13
|
+
```
|
|
14
|
+
3. **权限要求**:按订阅的数据权限控制。更新后的 API 文档标记 `/plus/pro/fullminute` 支持 WebSocket 推送且权限为 2、3;`/plus/expert/fivelevel` 和 `/plus/expert/fullbid` 支持推送且权限为 3。权限代码说明见 [API 文档](apidoc.md)。
|
|
15
|
+
4. **获取源码**:如遇问题,可从 GitHub 获取最新示例代码
|
|
16
|
+
- GitHub 项目地址:https://github.com/tickplusx/TickPlusSkill
|
|
17
|
+
- 包含完整的 WebSocket 客户端实现和使用示例
|
|
18
|
+
|
|
19
|
+
## API 文档中的 WebSocket 推送接口
|
|
20
|
+
|
|
21
|
+
`apidoc.json` 的 WebSocket 推送标签标记以下 REST 数据接口:
|
|
22
|
+
|
|
23
|
+
| 接口 | 数据 | 权限代码 |
|
|
24
|
+
| --- | --- | --- |
|
|
25
|
+
| `/plus/pro/fullminute` | 盘中分钟 K 线 | 2、3 |
|
|
26
|
+
| `/plus/expert/fivelevel` | 买卖五档 | 3 |
|
|
27
|
+
| `/plus/expert/fullbid` | 集合竞价 | 3 |
|
|
28
|
+
|
|
29
|
+
股票代码和 `auction` 等订阅值按服务端 WebSocket 协议使用;接口文档仅标明哪些数据接口支持推送,不定义订阅消息的 `authCodes` 映射。消息格式和调用方式以本指南现有示例及客户端实现为准。
|
|
30
|
+
|
|
31
|
+
## WebSocket 客户端使用
|
|
32
|
+
|
|
33
|
+
### 1. 基本连接流程
|
|
34
|
+
|
|
35
|
+
```python
|
|
36
|
+
from tickplus.scripts.StockWebSocketClient import StockWebSocketClient
|
|
37
|
+
from tickplus.scripts.Config import Config
|
|
38
|
+
import time
|
|
39
|
+
|
|
40
|
+
# 配置参数
|
|
41
|
+
token = Config.TOKEN # 从配置文件获取 Token
|
|
42
|
+
ws_url = f"ws://ws.tickplus.org/ws/{token}" # WebSocket 连接地址
|
|
43
|
+
# 注意:URL格式为 ws://ws.tickplus.org/ws/{token},token作为路径参数传递
|
|
44
|
+
|
|
45
|
+
# 创建客户端实例
|
|
46
|
+
client = StockWebSocketClient(ws_url)
|
|
47
|
+
|
|
48
|
+
# 建立连接
|
|
49
|
+
if client.connect():
|
|
50
|
+
print("成功连接到 WebSocket 服务器")
|
|
51
|
+
|
|
52
|
+
# 订阅数据
|
|
53
|
+
auth_codes = ["auction", "000001.SZ", "600000.SH"]
|
|
54
|
+
client.subscribe(token, auth_codes)
|
|
55
|
+
|
|
56
|
+
# 等待接收数据
|
|
57
|
+
print("等待接收数据...")
|
|
58
|
+
time.sleep(10)
|
|
59
|
+
|
|
60
|
+
# 取消订阅
|
|
61
|
+
client.unsubscribe(token, auth_codes)
|
|
62
|
+
|
|
63
|
+
# 断开连接
|
|
64
|
+
client.disconnect()
|
|
65
|
+
else:
|
|
66
|
+
print("连接失败")
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 2. 自定义消息处理
|
|
70
|
+
|
|
71
|
+
您可以继承 `StockWebSocketClient` 类并重写 `on_message` 方法来自定义数据处理逻辑:
|
|
72
|
+
|
|
73
|
+
```python
|
|
74
|
+
import json
|
|
75
|
+
from tickplus.scripts.StockWebSocketClient import StockWebSocketClient
|
|
76
|
+
from tickplus.scripts.util import DataUtil
|
|
77
|
+
|
|
78
|
+
class CustomWebSocketClient(StockWebSocketClient):
|
|
79
|
+
def on_message(self, message):
|
|
80
|
+
"""自定义消息处理"""
|
|
81
|
+
if isinstance(message, bytes):
|
|
82
|
+
# 处理二进制数据(压缩的股票行情)
|
|
83
|
+
packet = DataUtil.process_data(message)
|
|
84
|
+
print(f"收到二进制数据: {packet}")
|
|
85
|
+
|
|
86
|
+
# 在这里添加您的业务逻辑
|
|
87
|
+
self.process_stock_data(packet)
|
|
88
|
+
else:
|
|
89
|
+
# 处理文本数据
|
|
90
|
+
try:
|
|
91
|
+
data = json.loads(message)
|
|
92
|
+
print(f"收到JSON数据: {data}")
|
|
93
|
+
|
|
94
|
+
# 在这里添加您的业务逻辑
|
|
95
|
+
self.process_json_data(data)
|
|
96
|
+
except (json.JSONDecodeError, TypeError):
|
|
97
|
+
print(f"收到文本数据: {message}")
|
|
98
|
+
|
|
99
|
+
def process_stock_data(self, data):
|
|
100
|
+
"""处理股票行情数据"""
|
|
101
|
+
# 实现您的数据处理逻辑
|
|
102
|
+
pass
|
|
103
|
+
|
|
104
|
+
def process_json_data(self, data):
|
|
105
|
+
"""处理JSON格式数据"""
|
|
106
|
+
# 实现您的数据处理逻辑
|
|
107
|
+
pass
|
|
108
|
+
|
|
109
|
+
# 使用自定义客户端
|
|
110
|
+
client = CustomWebSocketClient(ws_url)
|
|
111
|
+
if client.connect():
|
|
112
|
+
# 订阅并接收数据
|
|
113
|
+
pass
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### 3. 错误处理和重连机制(扩展示例)
|
|
117
|
+
|
|
118
|
+
> **注意**:以下重连机制为扩展示例,非源代码直接提供的功能。
|
|
119
|
+
> 如需获取官方完整实现,请访问:https://github.com/tickplusx/TickPlusSkill
|
|
120
|
+
|
|
121
|
+
```python
|
|
122
|
+
import time
|
|
123
|
+
from tickplus.scripts.StockWebSocketClient import StockWebSocketClient
|
|
124
|
+
|
|
125
|
+
class RobustWebSocketClient(StockWebSocketClient):
|
|
126
|
+
def __init__(self, url, max_retries=3, retry_delay=5):
|
|
127
|
+
super().__init__(url)
|
|
128
|
+
self.max_retries = max_retries
|
|
129
|
+
self.retry_delay = retry_delay
|
|
130
|
+
self.reconnect_count = 0
|
|
131
|
+
|
|
132
|
+
def on_error(self, error):
|
|
133
|
+
"""错误处理"""
|
|
134
|
+
print(f"发生错误: {error}")
|
|
135
|
+
self.connected = False
|
|
136
|
+
|
|
137
|
+
# 尝试重连
|
|
138
|
+
if self.reconnect_count < self.max_retries:
|
|
139
|
+
self.reconnect_count += 1
|
|
140
|
+
print(f"尝试第 {self.reconnect_count} 次重连...")
|
|
141
|
+
time.sleep(self.retry_delay)
|
|
142
|
+
self.connect()
|
|
143
|
+
else:
|
|
144
|
+
print("达到最大重连次数,停止重连")
|
|
145
|
+
|
|
146
|
+
def on_close(self, close_status_code, close_msg):
|
|
147
|
+
"""连接关闭处理"""
|
|
148
|
+
print(f"连接关闭. 代码: {close_status_code}, 消息: {close_msg}")
|
|
149
|
+
self.connected = False
|
|
150
|
+
|
|
151
|
+
# 如果不是主动断开,则尝试重连
|
|
152
|
+
if self.reconnect_count < self.max_retries:
|
|
153
|
+
self.reconnect_count += 1
|
|
154
|
+
print(f"尝试第 {self.reconnect_count} 次重连...")
|
|
155
|
+
time.sleep(self.retry_delay)
|
|
156
|
+
self.connect()
|
|
157
|
+
|
|
158
|
+
# 使用增强版客户端
|
|
159
|
+
client = RobustWebSocketClient(ws_url, max_retries=5, retry_delay=3)
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## 订阅管理
|
|
163
|
+
|
|
164
|
+
### 支持的订阅类型
|
|
165
|
+
|
|
166
|
+
| 类型 | 说明 | 示例 |
|
|
167
|
+
|------|------|------|
|
|
168
|
+
| 个股 tick | 深圳/上海证券交易所个股 tick 数据,按个数订阅 | `"000001.SZ"`、`"600000.SH"` |
|
|
169
|
+
| auction | 沪深京A股集合竞价数据(09:15-09:25) | `"auction"` |
|
|
170
|
+
| minute.hsj | 沪深京A股 1 分钟 K 线数据 | `"minute.hsj"` |
|
|
171
|
+
| minute.index | 指数 1 分钟 K 线数据 | `"minute.index"` |
|
|
172
|
+
| minute.etf | ETF 1 分钟 K 线数据 | `"minute.etf"` |
|
|
173
|
+
|
|
174
|
+
订阅类型与 REST 接口、权限的对应关系:
|
|
175
|
+
|
|
176
|
+
| authCode | 对应 REST 接口 | 权限代码 |
|
|
177
|
+
| --- | --- | --- |
|
|
178
|
+
| `000001.SZ` / `600000.SH` | `/plus/basic/fullquotes`、`/plus/expert/fivelevel` | 1、2、3 / 3 |
|
|
179
|
+
| `auction` | `/plus/expert/fullbid` | 3 |
|
|
180
|
+
| `minute.hsj` / `minute.index` / `minute.etf` | `/plus/pro/fullminute` | 2、3 |
|
|
181
|
+
|
|
182
|
+
**注意**:股票代码格式为 `{代码}.{市场}`,例如:
|
|
183
|
+
- 深市:`000001.SZ`, `000002.SZ`
|
|
184
|
+
- 沪市:`600000.SH`, `600001.SH`
|
|
185
|
+
- 具体支持的股票代码请参考官方文档或使用 `BasicApi.getStockList()` 获取
|
|
186
|
+
|
|
187
|
+
### 订阅操作
|
|
188
|
+
|
|
189
|
+
```python
|
|
190
|
+
# 订阅单只股票
|
|
191
|
+
client.subscribe(token, ["000001.SZ"])
|
|
192
|
+
|
|
193
|
+
# 订阅多只股票
|
|
194
|
+
client.subscribe(token, ["000001.SZ", "600000.SH", "000002.SZ"])
|
|
195
|
+
|
|
196
|
+
# 订阅集合竞价数据
|
|
197
|
+
client.subscribe(token, ["auction"])
|
|
198
|
+
|
|
199
|
+
# 订阅沪深京A股 1 分钟 K 线
|
|
200
|
+
client.subscribe(token, ["minute.hsj"])
|
|
201
|
+
|
|
202
|
+
# 混合订阅
|
|
203
|
+
client.subscribe(token, ["auction", "000001.SZ", "minute.hsj"])
|
|
204
|
+
|
|
205
|
+
# 取消订阅
|
|
206
|
+
client.unsubscribe(token, ["000001.SZ"])
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### 动态订阅管理
|
|
210
|
+
|
|
211
|
+
```python
|
|
212
|
+
class DynamicSubscriptionManager:
|
|
213
|
+
def __init__(self, ws_client, token):
|
|
214
|
+
self.client = ws_client
|
|
215
|
+
self.token = token
|
|
216
|
+
self.subscribed_codes = set()
|
|
217
|
+
|
|
218
|
+
def add_subscription(self, codes):
|
|
219
|
+
"""添加订阅"""
|
|
220
|
+
new_codes = [code for code in codes if code not in self.subscribed_codes]
|
|
221
|
+
if new_codes:
|
|
222
|
+
self.client.subscribe(self.token, new_codes)
|
|
223
|
+
self.subscribed_codes.update(new_codes)
|
|
224
|
+
print(f"新增订阅: {new_codes}")
|
|
225
|
+
|
|
226
|
+
def remove_subscription(self, codes):
|
|
227
|
+
"""移除订阅"""
|
|
228
|
+
existing_codes = [code for code in codes if code in self.subscribed_codes]
|
|
229
|
+
if existing_codes:
|
|
230
|
+
self.client.unsubscribe(self.token, existing_codes)
|
|
231
|
+
self.subscribed_codes -= set(existing_codes)
|
|
232
|
+
print(f"取消订阅: {existing_codes}")
|
|
233
|
+
|
|
234
|
+
def get_current_subscriptions(self):
|
|
235
|
+
"""获取当前订阅列表"""
|
|
236
|
+
return list(self.subscribed_codes)
|
|
237
|
+
|
|
238
|
+
# 使用示例
|
|
239
|
+
manager = DynamicSubscriptionManager(client, token)
|
|
240
|
+
manager.add_subscription(["000001.SZ", "600000.SH"])
|
|
241
|
+
manager.remove_subscription(["000001.SZ"])
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
## 数据格式说明
|
|
245
|
+
|
|
246
|
+
### 接收的数据类型
|
|
247
|
+
|
|
248
|
+
WebSocket 客户端可以接收两种类型的数据:
|
|
249
|
+
|
|
250
|
+
1. **文本数据**:JSON 格式的元数据或控制信息
|
|
251
|
+
2. **二进制数据**:压缩的股票行情数据(gzip 或 zip 格式)
|
|
252
|
+
|
|
253
|
+
### 数据处理流程
|
|
254
|
+
|
|
255
|
+
```python
|
|
256
|
+
def on_message(self, message):
|
|
257
|
+
if isinstance(message, bytes):
|
|
258
|
+
# 二进制数据 - 通常是压缩的股票行情
|
|
259
|
+
packet = DataUtil.process_data(message)
|
|
260
|
+
# packet 是解压后的 JSON 数据
|
|
261
|
+
else:
|
|
262
|
+
# 文本数据 - 可能是 JSON 或纯文本
|
|
263
|
+
try:
|
|
264
|
+
data = json.loads(message)
|
|
265
|
+
# 处理 JSON 数据
|
|
266
|
+
except:
|
|
267
|
+
# 处理纯文本数据
|
|
268
|
+
pass
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### 典型数据结构
|
|
272
|
+
|
|
273
|
+
推送数据的字段随订阅类型不同,与对应 REST 接口的返回字段一致(详见 [API 文档](apidoc.md)):
|
|
274
|
+
|
|
275
|
+
- `000001.SZ`(个股 tick)→ 同 `/plus/basic/fullquotes`:`t`、`code`、`o`、`c`、`h`、`l`、`v`、`a`、`pc`
|
|
276
|
+
- `auction`(集合竞价)→ 同 `/plus/expert/fullbid`:`code`、`t`、`p`、`pc`、`zf`、`jv`、`je`、`nv`、`ne`、`bs`
|
|
277
|
+
- `minute.*`(分钟 K 线)→ 同 `/plus/pro/fullminute`:`t`、`code`、`o`、`c`、`h`、`l`、`v`、`a`、`pc`
|
|
278
|
+
- 行情指标类数据字段为:`code`、`tradeDate`、`zxj`(最新价)、`zdf`(涨跌幅)、`hsl`(换手率)、`lb`(量比)、`zsz`(总市值)等
|
|
279
|
+
|
|
280
|
+
## 高级用法
|
|
281
|
+
|
|
282
|
+
> **说明**:以下高级用法为扩展示例,展示了如何基于 StockWebSocketClient 进行功能扩展。
|
|
283
|
+
> 如需获取官方完整实现和更多示例,请访问:https://github.com/tickplusx/TickPlusSkill
|
|
284
|
+
|
|
285
|
+
### 1. 数据缓存和批处理(扩展示例)
|
|
286
|
+
|
|
287
|
+
```python
|
|
288
|
+
import queue
|
|
289
|
+
import threading
|
|
290
|
+
from collections import defaultdict
|
|
291
|
+
|
|
292
|
+
class BatchDataProcessor:
|
|
293
|
+
def __init__(self):
|
|
294
|
+
self.data_queue = queue.Queue()
|
|
295
|
+
self.batch_size = 100
|
|
296
|
+
self.batch_timeout = 5 # 秒
|
|
297
|
+
self.running = True
|
|
298
|
+
self.processor_thread = threading.Thread(target=self._process_batch)
|
|
299
|
+
self.processor_thread.daemon = True
|
|
300
|
+
self.processor_thread.start()
|
|
301
|
+
|
|
302
|
+
def add_data(self, data):
|
|
303
|
+
"""添加数据到队列"""
|
|
304
|
+
self.data_queue.put(data)
|
|
305
|
+
|
|
306
|
+
def _process_batch(self):
|
|
307
|
+
"""批量处理数据"""
|
|
308
|
+
batch = []
|
|
309
|
+
last_process_time = time.time()
|
|
310
|
+
|
|
311
|
+
while self.running:
|
|
312
|
+
try:
|
|
313
|
+
# 非阻塞获取数据
|
|
314
|
+
data = self.data_queue.get_nowait()
|
|
315
|
+
batch.append(data)
|
|
316
|
+
|
|
317
|
+
# 检查是否达到批处理条件
|
|
318
|
+
if len(batch) >= self.batch_size or \
|
|
319
|
+
time.time() - last_process_time >= self.batch_timeout:
|
|
320
|
+
self._handle_batch(batch)
|
|
321
|
+
batch = []
|
|
322
|
+
last_process_time = time.time()
|
|
323
|
+
|
|
324
|
+
except queue.Empty:
|
|
325
|
+
time.sleep(0.1)
|
|
326
|
+
continue
|
|
327
|
+
|
|
328
|
+
def _handle_batch(self, batch):
|
|
329
|
+
"""处理批次数据"""
|
|
330
|
+
print(f"处理批次数据,共 {len(batch)} 条记录")
|
|
331
|
+
# 实现您的批处理逻辑
|
|
332
|
+
|
|
333
|
+
# 在 WebSocket 客户端中使用
|
|
334
|
+
class BatchedWebSocketClient(StockWebSocketClient):
|
|
335
|
+
def __init__(self, url):
|
|
336
|
+
super().__init__(url)
|
|
337
|
+
self.batch_processor = BatchDataProcessor()
|
|
338
|
+
|
|
339
|
+
def on_message(self, message):
|
|
340
|
+
if isinstance(message, bytes):
|
|
341
|
+
packet = DataUtil.process_data(message)
|
|
342
|
+
self.batch_processor.add_data(packet)
|
|
343
|
+
else:
|
|
344
|
+
try:
|
|
345
|
+
data = json.loads(message)
|
|
346
|
+
self.batch_processor.add_data(data)
|
|
347
|
+
except:
|
|
348
|
+
pass
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
### 2. 数据过滤和路由(扩展示例)
|
|
352
|
+
|
|
353
|
+
```python
|
|
354
|
+
class FilteredWebSocketClient(StockWebSocketClient):
|
|
355
|
+
def __init__(self, url):
|
|
356
|
+
super().__init__(url)
|
|
357
|
+
self.filters = {}
|
|
358
|
+
self.handlers = {}
|
|
359
|
+
|
|
360
|
+
def add_filter(self, code_pattern, handler):
|
|
361
|
+
"""添加过滤器和处理器"""
|
|
362
|
+
self.filters[code_pattern] = handler
|
|
363
|
+
|
|
364
|
+
def on_message(self, message):
|
|
365
|
+
if isinstance(message, bytes):
|
|
366
|
+
packet = DataUtil.process_data(message)
|
|
367
|
+
self._route_data(packet)
|
|
368
|
+
else:
|
|
369
|
+
try:
|
|
370
|
+
data = json.loads(message)
|
|
371
|
+
self._route_data(data)
|
|
372
|
+
except:
|
|
373
|
+
pass
|
|
374
|
+
|
|
375
|
+
def _route_data(self, data):
|
|
376
|
+
"""根据数据内容路由到不同处理器"""
|
|
377
|
+
if isinstance(data, dict) and 'code' in data:
|
|
378
|
+
code = data['code']
|
|
379
|
+
for pattern, handler in self.filters.items():
|
|
380
|
+
if pattern in code or pattern == '*': # * 表示所有
|
|
381
|
+
handler(data)
|
|
382
|
+
break
|
|
383
|
+
|
|
384
|
+
# 使用示例
|
|
385
|
+
def handle_pingan_bank(data):
|
|
386
|
+
print(f"平安银行数据: {data}")
|
|
387
|
+
|
|
388
|
+
def handle_all_stocks(data):
|
|
389
|
+
print(f"所有股票数据: {data}")
|
|
390
|
+
|
|
391
|
+
client = FilteredWebSocketClient(ws_url)
|
|
392
|
+
client.add_filter("000001", handle_pingan_bank)
|
|
393
|
+
client.add_filter("*", handle_all_stocks)
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
## 性能优化建议
|
|
397
|
+
|
|
398
|
+
### 1. 连接管理
|
|
399
|
+
|
|
400
|
+
- **复用连接**:避免频繁创建和销毁 WebSocket 连接
|
|
401
|
+
- **合理订阅**:只订阅需要的股票,避免不必要的带宽消耗
|
|
402
|
+
- **超时设置**:设置合理的连接超时时间
|
|
403
|
+
|
|
404
|
+
### 2. 数据处理
|
|
405
|
+
|
|
406
|
+
- **异步处理**:将数据处理移到单独线程,避免阻塞 WebSocket 接收
|
|
407
|
+
- **批量处理**:对高频数据进行批量处理以提高效率
|
|
408
|
+
- **内存管理**:及时清理不需要的数据,避免内存泄漏
|
|
409
|
+
|
|
410
|
+
### 3. 错误恢复
|
|
411
|
+
|
|
412
|
+
- **重连机制**:实现自动重连功能
|
|
413
|
+
- **心跳检测**:定期发送心跳包检测连接状态
|
|
414
|
+
- **日志记录**:记录关键事件便于问题排查
|
|
415
|
+
|
|
416
|
+
## 常见问题
|
|
417
|
+
|
|
418
|
+
### Q1: 连接失败怎么办?
|
|
419
|
+
|
|
420
|
+
**排查步骤**:
|
|
421
|
+
|
|
422
|
+
1. **检查 Token 是否正确**
|
|
423
|
+
```python
|
|
424
|
+
from tickplus.scripts.Config import Config
|
|
425
|
+
print(f"当前Token: {Config.TOKEN}")
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
2. **检查网络连接**
|
|
429
|
+
```python
|
|
430
|
+
import socket
|
|
431
|
+
try:
|
|
432
|
+
socket.create_connection(("ws.tickplus.org", 80), timeout=5)
|
|
433
|
+
print("网络连接正常")
|
|
434
|
+
except Exception as e:
|
|
435
|
+
print(f"网络连接失败: {e}")
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
3. **确认账号权限与订阅数据类型匹配**
|
|
439
|
+
- 个股 tick(`000001.SZ`)对应 `/plus/basic/fullquotes`(权限 1、2、3)与 `/plus/expert/fivelevel`(权限 3)
|
|
440
|
+
- 集合竞价(`auction`)对应 `/plus/expert/fullbid`,需要专业版 (3)
|
|
441
|
+
- 分钟 K 线(`minute.hsj` / `minute.index` / `minute.etf`)对应 `/plus/pro/fullminute`,需要高级版 (2) 及以上
|
|
442
|
+
- 请登录官网确认您的账户权限
|
|
443
|
+
|
|
444
|
+
4. **获取官方示例代码**
|
|
445
|
+
- 如果仍然无法连接,建议从 GitHub 获取最新示例代码
|
|
446
|
+
- GitHub 地址:https://github.com/tickplusx/TickPlusSkill
|
|
447
|
+
- 参考 `tickplus/scripts/StockWebSocketClient.py` 的完整实现
|
|
448
|
+
|
|
449
|
+
```python
|
|
450
|
+
try:
|
|
451
|
+
if not client.connect(timeout=30):
|
|
452
|
+
print("连接超时,请检查网络和Token")
|
|
453
|
+
except Exception as e:
|
|
454
|
+
print(f"连接异常: {e}")
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
### Q2: 收不到数据?
|
|
458
|
+
|
|
459
|
+
**排查步骤**:
|
|
460
|
+
|
|
461
|
+
1. **确认已成功订阅**
|
|
462
|
+
```python
|
|
463
|
+
# 检查 subscribe() 返回值
|
|
464
|
+
result = client.subscribe(token, auth_codes)
|
|
465
|
+
if result:
|
|
466
|
+
print("订阅成功")
|
|
467
|
+
else:
|
|
468
|
+
print("订阅失败,请检查连接状态")
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
2. **检查交易时间**
|
|
472
|
+
- A股交易时间:09:30-11:30, 13:00-15:00
|
|
473
|
+
- 集合竞价时间:09:15-09:25
|
|
474
|
+
- 非交易时间可能无数据推送
|
|
475
|
+
|
|
476
|
+
3. **验证股票代码格式**
|
|
477
|
+
```python
|
|
478
|
+
# 正确的格式示例
|
|
479
|
+
auth_codes = ["auction", "000001.SZ", "600000.SH"]
|
|
480
|
+
# 错误格式:"000001" (缺少市场后缀)
|
|
481
|
+
```
|
|
482
|
+
|
|
483
|
+
4. **启用调试模式**
|
|
484
|
+
```python
|
|
485
|
+
# 在 connect() 方法中修改
|
|
486
|
+
websocket.enableTrace(True) # 查看详细握手信息
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
5. **添加详细日志**
|
|
490
|
+
```python
|
|
491
|
+
def on_message(self, message):
|
|
492
|
+
print(f"收到消息类型: {type(message)}")
|
|
493
|
+
print(f"消息长度: {len(message) if message else 0}")
|
|
494
|
+
# ... 其他处理逻辑
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
6. **参考官方示例**
|
|
498
|
+
- 运行官方测试脚本:`python tickplus/scripts/StockWebSocketClient.py`
|
|
499
|
+
- GitHub 地址:https://github.com/tickplusx/TickPlusSkill
|
|
500
|
+
|
|
501
|
+
### Q3: 如何处理大量数据?(扩展示例)
|
|
502
|
+
|
|
503
|
+
> 以下为性能优化扩展示例,实际使用时请根据需求调整。
|
|
504
|
+
|
|
505
|
+
```python
|
|
506
|
+
# 使用队列和异步处理
|
|
507
|
+
import queue
|
|
508
|
+
import threading
|
|
509
|
+
|
|
510
|
+
class HighPerformanceClient(StockWebSocketClient):
|
|
511
|
+
def __init__(self, url):
|
|
512
|
+
super().__init__(url)
|
|
513
|
+
self.data_queue = queue.Queue(maxsize=10000)
|
|
514
|
+
self.workers = []
|
|
515
|
+
|
|
516
|
+
# 启动多个工作线程
|
|
517
|
+
for i in range(3):
|
|
518
|
+
worker = threading.Thread(target=self._worker, args=(i,))
|
|
519
|
+
worker.daemon = True
|
|
520
|
+
worker.start()
|
|
521
|
+
self.workers.append(worker)
|
|
522
|
+
|
|
523
|
+
def _worker(self, worker_id):
|
|
524
|
+
"""工作线程"""
|
|
525
|
+
while True:
|
|
526
|
+
try:
|
|
527
|
+
data = self.data_queue.get(timeout=1)
|
|
528
|
+
self._process_data(data, worker_id)
|
|
529
|
+
self.data_queue.task_done()
|
|
530
|
+
except queue.Empty:
|
|
531
|
+
continue
|
|
532
|
+
|
|
533
|
+
def on_message(self, message):
|
|
534
|
+
if isinstance(message, bytes):
|
|
535
|
+
packet = DataUtil.process_data(message)
|
|
536
|
+
try:
|
|
537
|
+
self.data_queue.put_nowait(packet)
|
|
538
|
+
except queue.Full:
|
|
539
|
+
print("队列已满,丢弃数据")
|
|
540
|
+
```
|
|
541
|
+
|
|
542
|
+
### Q4: 如何获取最新的示例代码?
|
|
543
|
+
|
|
544
|
+
如果遇到任何问题,建议从 GitHub 获取最新的官方示例代码:
|
|
545
|
+
|
|
546
|
+
1. **访问 GitHub 项目**
|
|
547
|
+
- 项目地址:https://github.com/tickplusx/TickPlusSkill
|
|
548
|
+
|
|
549
|
+
2. **克隆或下载代码**
|
|
550
|
+
```bash
|
|
551
|
+
git clone https://github.com/tickplusx/TickPlusSkill.git
|
|
552
|
+
cd TickPlusSkill
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
3. **查看 WebSocket 示例**
|
|
556
|
+
- 文件路径:`tickplus/scripts/StockWebSocketClient.py`
|
|
557
|
+
- 运行测试:`python tickplus/scripts/StockWebSocketClient.py`
|
|
558
|
+
|
|
559
|
+
4. **参考文档**
|
|
560
|
+
- SKILL 文档:`tickplus/SKILL.md`
|
|
561
|
+
- API 文档:`tickplus/references/apidoc.md`
|
|
562
|
+
|
|
563
|
+
## 完整示例
|
|
564
|
+
|
|
565
|
+
以下是一个完整的 WebSocket 客户端使用示例:
|
|
566
|
+
|
|
567
|
+
```python
|
|
568
|
+
#!/usr/bin/env python3
|
|
569
|
+
# -*- coding: utf-8 -*-
|
|
570
|
+
|
|
571
|
+
"""
|
|
572
|
+
TickPlus WebSocket 完整示例
|
|
573
|
+
展示如何连接、订阅、接收和处理实时股票数据
|
|
574
|
+
"""
|
|
575
|
+
|
|
576
|
+
import json
|
|
577
|
+
import time
|
|
578
|
+
import signal
|
|
579
|
+
import sys
|
|
580
|
+
from datetime import datetime
|
|
581
|
+
|
|
582
|
+
from tickplus.scripts.StockWebSocketClient import StockWebSocketClient
|
|
583
|
+
from tickplus.scripts.Config import Config
|
|
584
|
+
from tickplus.scripts.util import DataUtil
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
class CompleteExampleClient(StockWebSocketClient):
|
|
588
|
+
"""完整的 WebSocket 客户端示例"""
|
|
589
|
+
|
|
590
|
+
def __init__(self, url):
|
|
591
|
+
super().__init__(url)
|
|
592
|
+
self.message_count = 0
|
|
593
|
+
self.start_time = None
|
|
594
|
+
self.running = True
|
|
595
|
+
|
|
596
|
+
# 注册信号处理器以优雅退出
|
|
597
|
+
signal.signal(signal.SIGINT, self._signal_handler)
|
|
598
|
+
signal.signal(signal.SIGTERM, self._signal_handler)
|
|
599
|
+
|
|
600
|
+
def _signal_handler(self, signum, frame):
|
|
601
|
+
"""处理中断信号"""
|
|
602
|
+
print("\n收到中断信号,正在关闭连接...")
|
|
603
|
+
self.running = False
|
|
604
|
+
self.disconnect()
|
|
605
|
+
sys.exit(0)
|
|
606
|
+
|
|
607
|
+
def on_open(self):
|
|
608
|
+
"""连接打开回调"""
|
|
609
|
+
super().on_open()
|
|
610
|
+
self.start_time = time.time()
|
|
611
|
+
print("开始订阅股票数据...")
|
|
612
|
+
|
|
613
|
+
# 订阅一些示例股票
|
|
614
|
+
token = Config.TOKEN
|
|
615
|
+
auth_codes = ["auction", "000001.SZ", "600000.SH", "000002.SZ"]
|
|
616
|
+
self.subscribe(token, auth_codes)
|
|
617
|
+
|
|
618
|
+
def on_message(self, message):
|
|
619
|
+
"""消息处理回调"""
|
|
620
|
+
self.message_count += 1
|
|
621
|
+
|
|
622
|
+
if isinstance(message, bytes):
|
|
623
|
+
# 处理二进制数据
|
|
624
|
+
try:
|
|
625
|
+
packet = DataUtil.process_data(message)
|
|
626
|
+
current_time = datetime.now().strftime("%H:%M:%S.%f")[:-3]
|
|
627
|
+
print(f"[{current_time}] 收到二进制数据 #{self.message_count}: {str(packet)[:100]}...")
|
|
628
|
+
|
|
629
|
+
# 在这里添加您的业务逻辑
|
|
630
|
+
self._process_stock_data(packet)
|
|
631
|
+
|
|
632
|
+
except Exception as e:
|
|
633
|
+
print(f"处理二进制数据时出错: {e}")
|
|
634
|
+
else:
|
|
635
|
+
# 处理文本数据
|
|
636
|
+
try:
|
|
637
|
+
data = json.loads(message)
|
|
638
|
+
current_time = datetime.now().strftime("%H:%M:%S.%f")[:-3]
|
|
639
|
+
print(f"[{current_time}] 收到JSON数据 #{self.message_count}: {data}")
|
|
640
|
+
|
|
641
|
+
except (json.JSONDecodeError, TypeError):
|
|
642
|
+
print(f"收到文本数据 #{self.message_count}: {message[:100]}...")
|
|
643
|
+
|
|
644
|
+
def on_error(self, error):
|
|
645
|
+
"""错误回调"""
|
|
646
|
+
super().on_error(error)
|
|
647
|
+
print(f"WebSocket 错误: {error}")
|
|
648
|
+
|
|
649
|
+
def on_close(self, close_status_code, close_msg):
|
|
650
|
+
"""关闭回调"""
|
|
651
|
+
super().on_close(close_status_code, close_msg)
|
|
652
|
+
if self.start_time:
|
|
653
|
+
duration = time.time() - self.start_time
|
|
654
|
+
print(f"会话持续时间: {duration:.2f} 秒")
|
|
655
|
+
print(f"总共接收消息: {self.message_count} 条")
|
|
656
|
+
|
|
657
|
+
def _process_stock_data(self, data):
|
|
658
|
+
"""处理股票数据的具体逻辑"""
|
|
659
|
+
# 这里可以实现您的业务逻辑
|
|
660
|
+
# 例如:数据存储、分析、报警等
|
|
661
|
+
pass
|
|
662
|
+
|
|
663
|
+
def run(self, duration=60):
|
|
664
|
+
"""运行客户端指定时长"""
|
|
665
|
+
print(f"启动 WebSocket 客户端,运行 {duration} 秒...")
|
|
666
|
+
|
|
667
|
+
if self.connect():
|
|
668
|
+
print("成功连接到 WebSocket 服务器")
|
|
669
|
+
|
|
670
|
+
# 运行指定时长
|
|
671
|
+
start_time = time.time()
|
|
672
|
+
while self.running and (time.time() - start_time) < duration:
|
|
673
|
+
time.sleep(1)
|
|
674
|
+
|
|
675
|
+
print("运行结束,断开连接...")
|
|
676
|
+
self.disconnect()
|
|
677
|
+
else:
|
|
678
|
+
print("无法连接到 WebSocket 服务器")
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
def main():
|
|
682
|
+
"""主函数"""
|
|
683
|
+
# 配置
|
|
684
|
+
token = Config.TOKEN
|
|
685
|
+
ws_url = f"ws://ws.tickplus.org/ws/{token}"
|
|
686
|
+
|
|
687
|
+
# 创建并运行客户端
|
|
688
|
+
client = CompleteExampleClient(ws_url)
|
|
689
|
+
client.run(duration=30) # 运行30秒
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
if __name__ == "__main__":
|
|
693
|
+
main()
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
## 相关资源
|
|
697
|
+
|
|
698
|
+
- [TickPlus 官方网站](http://www.tickplus.org)
|
|
699
|
+
- [GitHub 项目地址](https://github.com/tickplusx/TickPlusSkill) - **获取最新示例代码**
|
|
700
|
+
- [API 文档](apidoc.md)
|
|
701
|
+
- [SKILL 文档](../SKILL.md)
|
|
702
|
+
- [StockWebSocketClient 源码](../scripts/StockWebSocketClient.py)
|
|
703
|
+
|
|
704
|
+
## 技术支持
|
|
705
|
+
|
|
706
|
+
如有问题,请访问以下资源:
|
|
707
|
+
|
|
708
|
+
1. **GitHub 项目**:https://github.com/tickplusx/TickPlusSkill
|
|
709
|
+
- 获取最新示例代码
|
|
710
|
+
- 查看 Issues 和解决方案
|
|
711
|
+
- 提交问题反馈
|
|
712
|
+
|
|
713
|
+
2. **官方网站**:http://www.tickplus.org
|
|
714
|
+
- 获取技术支持
|
|
715
|
+
- 查看最新文档
|
|
716
|
+
- 账户和权限管理
|
|
717
|
+
|
|
718
|
+
3. **运行官方测试**
|
|
719
|
+
```bash
|
|
720
|
+
# 从 GitHub 克隆项目后
|
|
721
|
+
python tickplus/scripts/StockWebSocketClient.py
|
|
722
|
+
```
|