Javascript SDK

npm install @itick/browser-sdk

yarn add @itick/browser-sdk

pnpm add @itick/browser-sdk

<!-- Using unpkg CDN -->
<script src="https://unpkg.com/@itick/browser-sdk@latest/dist/itick-sdk.min.js"></script>

<!-- Or using jsDelivr CDN -->
<script src="https://cdn.jsdelivr.net/npm/@itick/browser-sdk@latest/dist/itick-sdk.min.js"></script>

<script>
  const { BaseClient, StockClient, CryptoClient, ForexClient, IndicesClient, FutureClient, FundClient } = window.iTickSDK;
</script>

import { StockClient } from "@itick/browser-sdk";

// 可选配置 （默认host api.itick.org）其他模块配置参照此配置
const options = {
  baseURL: "https://api-free.itick.org",
  wssURL: "wss://api-free.itick.org",
};
// API Token
const token = process.env.ITICK_TOKEN;
// 初始化客户端
const client = new StockClient(token, options);

// 获取股票报价
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();

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();

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");

import { StockClient } from "@itick/browser-sdk";

const client = new StockClient(token);

// 获取单只股票信息
await client.getInfo({ region: "US", code: "AAPL" });

// 获取实时报价
await client.getQuote({ region: "US", code: "AAPL" });

// 获取盘口深度
await client.getDepth({ region: "US", code: "AAPL" });

// 获取最新成交
await client.getTick({ region: "US", code: "AAPL" });

// 获取 K 线数据
await client.getKline({
  region: "US",
  code: "AAPL",
  interval: "5m",
  limit: 100,
});

// 批量查询
await client.getQuotes({ region: "US", codes: ["AAPL", "MSFT", "GOOGL"] });
await client.getDepths({ region: "US", codes: ["AAPL", "MSFT"] });
await client.getTicks({ region: "US", codes: ["AAPL", "MSFT"] });
await client.getKlines({
  region: "US",
  codes: ["AAPL", "MSFT"],
  interval: "1d",
  limit: 50,
});

// IPO 信息
await client.getIPO({ region: "US", code: "RIVN" });

// 除权因子	
await client.getSplit({ region: "US", code: "AAPL" });

import { CryptoClient } from "@itick/browser-sdk";

const client = new CryptoClient(token);

// 获取实时数据
await client.getQuote({ region: "BA", code: "BTCUSDT" });
await client.getDepth({ region: "BA", code: "ETHUSDT" });
await client.getTick({ region: "BA", code: "BTCUSDT" });

// 获取 K 线数据
await client.getKline({
  region: "BA",
  code: "BTCUSDT",
  interval: "1h",
  limit: 100,
});

// 批量查询
await client.getQuotes({ region: "BA", codes: ["BTCUSDT", "ETHUSDT"] });

import { ForexClient } from "@itick/browser-sdk";

const client = new ForexClient(token);

await client.getQuote({ region: "GB", code: "EURUSD" });
await client.getDepth({ region: "GB", code: "GBPUSD" });
await client.getTick({ region: "GB", code: "USDJPY" });
await client.getKline({ region: "GB", code: "EURUSD", interval: "1d", limit: 50 });

import { IndicesClient } from "@itick/browser-sdk";

const client = new IndicesClient(token);

await client.getQuote({ region: "US", code: "SPX" });
await client.getDepth({ region: "US", code: "NDX" });
await client.getKline({ region: "US", code: "DJI", interval: "1w", limit: 20 });

import { FutureClient } from "@itick/browser-sdk";

const client = new FutureClient(token);

await client.getQuote({ region: "US", code: "ES" });
await client.getDepth({ region: "US", code: "NQ" });
await client.getKline({ region: "US", code: "CL", interval: "5m", limit: 100 });

import { FundClient } from "@itick/browser-sdk";

const client = new FundClient(token);

await client.getQuote({ region: "US", code: "VOO" });
await client.getDepth({ region: "US", code: "QQQ" });
await client.getKline({ region: "US", code: "SPY", interval: "1d", limit: 100 });

const socket = client.createSocket({
  maxReconnectTimes: 10, // 最大重连次数（0 = 无限）
  reconnectInterval: 5000, // 重连间隔（毫秒）
  pingInterval: 30000, // Ping 间隔（毫秒）
  subscribeData: {
    codes: ["AAPL$US", "MSFT$US"],
    types: ["quote", "tick", "kline@1m"],
  },
});

// 连接打开
socket.onSocketOpen(() => {
  console.log("已连接！");
});

// 接收消息
socket.onSocketMessage((data) => {
  console.log("收到数据:", data);
});

// 发生错误
socket.onSocketError((error) => {
  console.error("错误:", error);
});

// 连接关闭
socket.onSocketClose(() => {
  console.log("已断开");
});

// 检查连接状态
const isConnected = socket.checkSocketConnected();

// 断开连接
socket.disconnectSocket();

// 连接后订阅
socket.subscribeSocket({
  ac: "subscribe",
  types: ["quote", "depth"],
  codes: ["TSLA$US", "NVDA$US"],
});

// 取消订阅
socket.subscribeSocket({
  ac: "unsubscribe",
  types: ["tick"],
  codes: ["AAPL$US"],
});

try {
  const response = await client.getQuote({ region: "US", code: "AAPL" });

  if (response.code !== 0) {
    console.error("API 错误:", response.msg);
    return;
  }

  // 处理数据
  console.log(response.data);
} catch (error) {
  if (error instanceof Error) {
    console.error("网络错误:", error.message);
  }
}

import type {
  APIResponse,
  QuoteData,
  SocketKlineData,
  SocketTickData,
  SocketDepthData,
  SocketQuoteData,
} from "@itick/browser-sdk";

// 类型安全的响应
const response: APIResponse<QuoteData> = await client.getQuote({
  region: "US",
  code: "AAPL",
});

// 类型安全的 WebSocket 消息
socket.onSocketMessage((response) => {
  const { code, data, msg, resAc } = response;
  if (data?.type === "quote") {
    const quoteData: SocketQuoteData = data;
  }
  if (data?.type === "kline@1") {
    const klineData: SocketKlineData = data;
  }
  if (data?.type === "tick") {
    const tickData: SocketTickData = data;
  }
  if (data?.type === "depth") {
    const depthData: SocketDepthData = data;
  }
});