iTick Web browser js SDK
[![npm version][npm-version-img]][npm-link]
[![CDNJS][cdn-js-img]][cdn-js-link]
[![install size][npm-install-size-img]][npm-install-size-link]
[![npm bundle size][bundle-size-img]][bundle-size-link]
[![license badge][license-img]][license-link]
[English](https://github.com/itick-org/nodejs-sdk/blob/main/README.md) | [中文简体](https://github.com/itick-org/nodejs-sdk/blob/main/README.zh-CN.md) | [中文繁体](https://github.com/itick-org/nodejs-sdk/blob/main/README.zh-HK.md)
可直接在web浏览器运行的的 iTick API SDK，提供基础、股票、指数、期货、基金、外汇、加密货币数据的 REST API 查询和 WebSocket 实时数据订阅功能。用于访问 iTick API 的实时金融市场数据。
## ✨ 特性
- **全面的市场覆盖**：访问全球金融市场，包括股票、加密货币、外汇、指数、期货和基金
- **实时数据**：基于 WebSocket 的实时数据流，支持自动重连
- **RESTful API**：简洁直观的 REST API，用于获取历史数据和快照
- **类型安全**：完整的 TypeScript 支持和全面的类型定义
- **自动重连**：内置自动重连机制（5 秒间隔，可设置无限次尝试）
- **心跳保活**：自动 ping/pong 机制（30 秒间隔）保持连接稳定
- **模块化设计**：按资产类型划分独立模块，结构更清晰
- **灵活订阅**：支持报价、盘口、成交和 K 线数据订阅
## 支持的浏览器
| Chrome | Firefox | Safari | Opera | Edge |
| :------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: |
|  |  |  |  |  |
| Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
## 🚀 安装
### 项目安装
使用 npm:
```bash
npm install @itick/browser-sdk
```
使用 yarn:
```bash
yarn add @itick/browser-sdk
```
使用 pnpm:
```bash
pnpm add @itick/browser-sdk
```
### CDN
```html
```
## 🎯 快速开始
### 基础用法
```javascript
import { StockClient } from "@itick/browser-sdk";
// 使用 API Token 初始化客户端
const token = process.env.ITICK_TOKEN;
const client = new StockClient(token);
// 获取股票报价
async function getQuote() {
try {
const response = await client.getQuote({ region: "US", code: "AAPL" });
if (response.code === 0 && response.data) {
console.log("最新价格:", response.data.ld);
console.log("涨跌幅:", response.data.chp);
}
} catch (error) {
console.error("错误:", error.message);
}
}
getQuote();
```
### 通过 WebSocket 获取实时数据
```javascript
import { CryptoClient } from "@itick/browser-sdk";
const client = new CryptoClient(token);
// 创建带订阅数据的 WebSocket 连接 SDK内部已处理连接和重连后直接订阅 subscribeData 数据 无需再发送订阅数据
const socket = client.createSocket({
maxReconnectTimes: 10, // 最大重连次数 不传则使用默认值 0 无限制重连
pingInterval: 30000, // ping 间隔 默认30 秒
reconnectInterval: 5000, // 重连间隔 默认5 秒
subscribeData: {
codes: ["BTCUSDT$BA", "ETHUSDT$BA"],
types: ["quote", "tick"],
},
});
// 创建自定义 WebSocket 连接
const socket = client.createSocket();
// 连接成功或者重连连成功后发送订阅数据
socket.onSocketOpen(() => {
socket.subscribeData({
codes: ["BTCUSDT$BA", "ETHUSDT$BA"],
types: ["quote", "tick"],
});
});
// 处理接收到的消息
socket.onSocketMessage((res) => {
console.log("收到数据:", res);
});
// 处理错误
socket.onSocketError((error) => {
console.error("WebSocket 错误:", error);
});
// 完成后断开连接
// socket.disconnectSocket();
```
## 📚 API 参考
### 基础模块
金融产品清单和市场节假日信息以及开市休市时间信息。
```typescript
import { BaseClient } from "@itick/browser-sdk";
const client = new BaseClient(token);
// 获取品种列表
await client.getSymbolList({ type: "stock", region: "US" });
await client.getSymbolList({ type: "crypto", region: "BA" });
await client.getSymbolList({ type: "forex", region: "GB" });
// 获取市场假期
await client.getSymbolHolidays("US");
await client.getSymbolHolidays("HK");
```
#### BaseClient 方法参考表
| 方法名 | 参数说明 | 返回值类型 | 描述 | 详细参数 |
| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------- | :----------------------------------------------------------------------- |
| `getSymbolList` | `options`: `Object`
