stock-api
TypeScript stock market data API for Node.js and browsers.
English |
简体中文
`stock-api` is a zero-runtime-dependency stock market data toolkit for Node.js, browsers, CLI usage, and MCP-compatible AI clients. Use `stocks.auto` by default to read from the first available provider.
## Supported Usage
## Installation
```shell
npm install stock-api
```
Node.js usage requires `>=18`.
## Usage
```typescript
import { stocks } from "stock-api";
const stock = await stocks.auto.getStock("SH510500");
const list = await stocks.auto.getStocks(["SH510500", "SZ000651"]);
const klines = await stocks.auto.getKlines("SH600519", { period: "day" });
const results = await stocks.auto.searchStocks("格力电器");
```
Stock codes use `SH` / `SZ` / `HK` / `US` prefixes, such as `SH510500` and `SZ000651`.
## Browser Usage
```html
```
Browser example: [GitHub Pages](https://zhangxiangliang.github.io/stock-api/web-demo/)
## CLI
```shell
npx stock-api get-stock SH510500
npx stock-api get-stocks SH510500 SZ000651
npx stock-api get-klines SH600519 --period day --count 120
npx stock-api search-stocks 格力电器
```
## MCP
Use `stock-api` from any MCP-compatible AI client:
```json
{
"mcpServers": {
"stock-api": {
"command": "npx",
"args": ["-y", "stock-api", "mcp"]
}
}
}
```
Built-in tools: `get_stock`, `get_stocks`, `get_klines`, `search_stocks`, and `inspect_stock`.
## Providers
Built-in providers include Tencent, Sina, and Eastmoney. `stocks.auto` handles provider fallback by default.
## Documentation
| Document | Description |
| ------------------------------------------- | ------------------------------------------------------- |
| [API usage](docs/api.EN.md) | TypeScript API, automatic fallback, inspection output |
| [CLI usage](docs/cli.EN.md) | Commands, options, output, and exit codes |
| [Architecture](docs/architecture.EN.md) | Directory layout, provider factory, parsing, and errors |
| [Development guide](docs/development.EN.md) | Local development, tests, release checks, and providers |
| [API monitoring](docs/monitoring.EN.md) | Scheduled third-party API checks and status badges |
## Disclaimer
`stock-api` uses third-party public market data endpoints and does not guarantee accuracy, completeness, real-time delivery, or continuous availability. This project does not provide investment advice. Any trading or investment decision is your own responsibility. Before commercial, high-frequency, or production use, verify the terms, authorization scope, and compliance requirements of the third-party data sources.
## License
MIT