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/javascript-sdk/blob/main/README.md) | [简体中文](https://github.com/itick-org/javascript-sdk/blob/main/README.zh-CN.md) | [繁體中文](https://github.com/itick-org/javascript-sdk/blob/main/README.zh-HK.md)
The web browser javascript SDK for iTick API, providing REST API queries and WebSocket real-time data subscription for basics, stocks, indices, futures, funds, forex, and crypto. Used to access real-time financial market data from the iTick API.
## ✨ Features
- **Comprehensive Market Coverage**: Access global financial markets including stocks, crypto, forex, indices, futures, and funds
- **Real-time Data**: WebSocket-based real-time data streaming with automatic reconnection support
- **RESTful API**: Clean and intuitive REST API for retrieving historical data and snapshots
- **Type Safety**: Full TypeScript support with comprehensive type definitions
- **Auto Reconnection**: Built-in automatic reconnection mechanism (5-second interval, configurable unlimited attempts)
- **Heartbeat Keep-alive**: Automatic ping/pong mechanism (30-second interval) to maintain stable connections
- **Modular Design**: Independent modules organized by asset type for clearer structure
- **Flexible Subscription**: Support for subscribing to quotes, order book depth, trades, and candlestick data
## Browser Support
| Chrome | Firefox | Safari | Opera | Edge |
| :------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------: |
|  |  |  |  |  |
| Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |
## 🚀 Installation
### Package manager
Using npm:
```bash
npm install @itick/browser-sdk
```
Using yarn:
```bash
yarn add @itick/browser-sdk
```
Using pnpm:
```bash
pnpm add @itick/browser-sdk
```
### CDN
```html
```
## 🎯 Quick Start
### Basic Usage
```javascript
import { StockClient } from "@itick/browser-sdk";
// Initialize client with API Token
const token = process.env.ITICK_TOKEN;
const client = new StockClient(token);
// Get stock quote
async function getQuote() {
try {
const response = await client.getQuote({ region: "US", code: "AAPL" });
if (response.code === 0 && response.data) {
console.log("Latest Price:", response.data.ld);
console.log("Change %:", response.data.chp);
}
} catch (error) {
console.error("Error:", error.message);
}
}
getQuote();
```
### Real-time Data via WebSocket
```javascript
import { CryptoClient } from "@itick/browser-sdk";
const client = new CryptoClient(token);
// Create WebSocket connection with subscription data - SDK handles connection and automatically subscribes after reconnection, no need to send subscription data again
const socket = client.createSocket({
maxReconnectTimes: 10, // Maximum reconnection attempts, default is 0 (unlimited)
pingInterval: 30000, // Ping interval, default 30 seconds
reconnectInterval: 5000, // Reconnection interval, default 5 seconds
subscribeData: {
codes: ["BTCUSDT$BA", "ETHUSDT$BA"],
types: ["quote", "tick"],
},
});
// Create custom WebSocket connection
const socket = client.createSocket();
// Send subscription data after successful connection or reconnection
socket.onSocketOpen(() => {
socket.subscribeData({
codes: ["BTCUSDT$BA", "ETHUSDT$BA"],
types: ["quote", "tick"],
});
});
// Handle received messages
socket.onSocketMessage((res) => {
console.log("Received data:", res);
});
// Handle errors
socket.onSocketError((error) => {
console.error("WebSocket error:", error);
});
// Disconnect when done
// socket.disconnectSocket();
```
## 📚 API Reference
### Base Module
Financial instrument listings, market holiday information, and trading hours.
```typescript
import { BaseClient } from "@itick/browser-sdk";
const client = new BaseClient(token);
// Get symbol list
await client.getSymbolList({ type: "stock", region: "US" });
await client.getSymbolList({ type: "crypto", region: "BA" });
await client.getSymbolList({ type: "forex", region: "GB" });
// Get market holidays
await client.getSymbolHolidays("US");
await client.getSymbolHolidays("HK");
```
#### BaseClient Method Reference Table
| Method Name | Parameters | Return Type | Description | Details |
| :------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------- | :----------------------------------------------------------------------------------- | :------------------------------------------------------------------------------ |
| `getSymbolList` | `options`: `Object`
