stock-sdk 1.2.1 → 1.2.2
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.
- package/README.md +61 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,12 +5,41 @@
|
|
|
5
5
|
[](https://github.com/chengzuopeng/stock-sdk/blob/master/LICENSE)
|
|
6
6
|
[](https://github.com/chengzuopeng/stock-sdk)
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
**[English](./README_EN.md)** | 中文
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
为 **前端和 Node.js 设计的股票行情 SDK**。
|
|
11
|
+
|
|
12
|
+
无需 Python、无需后端服务，直接在 **浏览器或 Node.js** 中获取 **A 股 / 港股 / 美股 / 公募基金** 的实时行情与 K 线数据。
|
|
13
|
+
|
|
14
|
+
**✨ 零依赖 | 🌐 Browser + Node.js | 📦 <10KB | 🧠 完整 TypeScript 类型**
|
|
11
15
|
|
|
12
16
|
📦 [NPM](https://www.npmjs.com/package/stock-sdk) | 📖 [GitHub](https://github.com/chengzuopeng/stock-sdk) | 🎮 [在线演示](https://chengzuopeng.github.io/stock-sdk/)
|
|
13
17
|
|
|
18
|
+
## Why stock-sdk？
|
|
19
|
+
|
|
20
|
+
如果你是前端工程师，可能遇到过这些问题：
|
|
21
|
+
|
|
22
|
+
* 股票行情工具大多是 **Python 生态**，前端难以直接使用
|
|
23
|
+
* 想做行情看板 / Demo，不想额外维护后端服务
|
|
24
|
+
* 财经接口返回格式混乱、编码复杂（GBK / 并发 / 批量）
|
|
25
|
+
* AkShare 很强，但并不适合浏览器或 Node.js 项目
|
|
26
|
+
|
|
27
|
+
**stock-sdk 的目标很简单：**
|
|
28
|
+
|
|
29
|
+
> 让前端工程师，用最熟悉的 JavaScript / TypeScript，优雅地获取股票行情数据。
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 使用场景
|
|
34
|
+
|
|
35
|
+
* 📊 股票行情看板（Web / Admin）
|
|
36
|
+
* 📈 数据可视化（ECharts / TradingView）
|
|
37
|
+
* 🎓 股票 / 金融课程 Demo
|
|
38
|
+
* 🧪 量化策略原型验证（JS / Node）
|
|
39
|
+
* 🕒 Node.js 定时抓取行情数据
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
14
43
|
## 特性
|
|
15
44
|
|
|
16
45
|
- ✅ **零依赖**，轻量级（压缩后 < 10KB）
|
|
@@ -32,22 +61,38 @@ yarn add stock-sdk
|
|
|
32
61
|
pnpm add stock-sdk
|
|
33
62
|
```
|
|
34
63
|
|
|
35
|
-
##
|
|
64
|
+
## 快速开始（10 行 Demo）
|
|
36
65
|
|
|
37
|
-
```
|
|
66
|
+
```ts
|
|
38
67
|
import { StockSDK } from 'stock-sdk';
|
|
39
68
|
|
|
40
69
|
const sdk = new StockSDK();
|
|
41
70
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
71
|
+
const quotes = await sdk.getSimpleQuotes([
|
|
72
|
+
'sh000001',
|
|
73
|
+
'sz000858',
|
|
74
|
+
'sh600519',
|
|
75
|
+
]);
|
|
76
|
+
|
|
77
|
+
quotes.forEach(q => {
|
|
78
|
+
console.log(`${q.name}: ${q.price} (${q.changePercent}%)`);
|
|
79
|
+
});
|
|
80
|
+
```
|
|
45
81
|
|
|
46
|
-
|
|
47
|
-
const klines = await sdk.getHistoryKline('000001', { period: 'daily' });
|
|
82
|
+
## 示例：全市场 A 股行情
|
|
48
83
|
|
|
49
|
-
|
|
50
|
-
|
|
84
|
+
前端直接一次性获取全市场 A 股行情（5000+股票），无需 Python 或后端服务。
|
|
85
|
+
|
|
86
|
+
```ts
|
|
87
|
+
const allQuotes = await sdk.getAllAShareQuotes({
|
|
88
|
+
batchSize: 300,
|
|
89
|
+
concurrency: 5,
|
|
90
|
+
onProgress: (completed, total) => {
|
|
91
|
+
console.log(`进度: ${completed}/${total}`);
|
|
92
|
+
},
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
console.log(`共获取 ${allQuotes.length} 只股票`);
|
|
51
96
|
```
|
|
52
97
|
|
|
53
98
|
## API 文档
|
|
@@ -495,7 +540,7 @@ console.log(raw[0].fields); // ['51', '五 粮 液', '000858', ...]
|
|
|
495
540
|
|
|
496
541
|
---
|
|
497
542
|
|
|
498
|
-
##
|
|
543
|
+
## 浏览器直接使用
|
|
499
544
|
|
|
500
545
|
SDK 使用原生 `TextDecoder` 解码 GBK 编码数据，无需额外 polyfill。
|
|
501
546
|
|
|
@@ -537,3 +582,7 @@ yarn dev
|
|
|
537
582
|
---
|
|
538
583
|
|
|
539
584
|
📦 [NPM](https://www.npmjs.com/package/stock-sdk) | 📖 [GitHub](https://github.com/chengzuopeng/stock-sdk) | 🎮 [在线演示](https://chengzuopeng.github.io/stock-sdk/) | 🐛 [Issues](https://github.com/chengzuopeng/stock-sdk/issues)
|
|
585
|
+
|
|
586
|
+
---
|
|
587
|
+
|
|
588
|
+
如果这个项目对你有帮助，欢迎 Star ⭐ 或提出 Issue 反馈。
|