stock-sdk

环境要求

• Node.js 18+ 环境
• npm 包管理器
• 支持 ESM 或 CommonJS 的 JavaScript/TypeScript 项目
• 浏览器环境也可直接使用

安装与启动步骤

1. 1安装 SDK

   在项目根目录执行安装命令，把 stock-sdk 加入依赖；SDK 零依赖，安装即用。

   npm i stock-sdk

   复制

2. 2初始化并取行情

   导入 StockSDK 并实例化，用 quotes.cnSimple 传代码数组，拿到名称、价格、涨跌幅。

   import { StockSDK } from 'stock-sdk';
   
   const sdk = new StockSDK();
   
   const quotes = await sdk.quotes.cnSimple(['sh000001', 'sz000858', 'sh600519']);
   quotes.forEach((q) => {
     console.log(`${q.name}: ${q.price} (${q.changePercent}%)`);
   });

   复制

3. 3获取K线与指标

   调用 kline.withIndicators 指定周期并配置 MA、MACD 等技术指标，返回历史 K 线。

   const kline = await sdk.kline.withIndicators('600519', {
     period: 'daily',
     indicators: { ma: { periods: [5, 10, 20] }, macd: {} },
   });

   复制

4. 4批量拉全市场

   用 batch.cn 拉取 5000+ 只 A 股行情，SDK 内置并发控制，可用 concurrency 调整。

   const all = await sdk.batch.cn({ concurrency: 5 });
   console.log(`共 ${all.length} 只`);

   复制

关键配置

如何确认成功

运行快速开始代码后，控制台打印出股票名称、价格与涨跌幅百分比即表示调用成功。

常见问题

注意事项

• README 指出需 Node.js 18+，低版本环境可能无法运行。
• v2 与 v1 不兼容，老项目升级前先看迁移文档。
• 同一份包同时提供 ESM 和 CommonJS，按项目模块规范选择引入方式。
• 完整 API、CLI、MCP 与在线 Playground 均在官网，README 只展示了快速开始示例。