JavaScript SDK - Browser Financial Data API REST & WebSocket Real-Time Streaming iTick Documentation SDK & Developer Tools Official iTick JavaScript Browser SDK providing REST API queries and WebSocket real-time data subscription for basic, stock, index, futures, fund, forex, and cryptocurrency market data with TypeScript support.

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

// Optional configuration (default host api.itick.org), other modules follow this configuration
const options = {
  baseURL: "https://api-free.itick.org",
  wssURL: "wss://api-free.itick.org",
};
// API Token
const token = process.env.ITICK_TOKEN;
// Initialize client
const client = new StockClient(token, options);

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

import { CryptoClient } from "@itick/browser-sdk";
const client = new CryptoClient(token);

// Create WebSocket connection with subscription data. SDK handles connection and automatically resubscribes after reconnection. No need to resend subscription data.
const socket = client.createSocket({
  maxReconnectTimes: 10, // Maximum reconnection attempts. Default is 0 (unlimited) if not specified
  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();

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

const client = new StockClient(token);

// Get single stock information
await client.getInfo({ region: "US", code: "AAPL" });

// Get real-time quote
await client.getQuote({ region: "US", code: "AAPL" });

// Get depth
await client.getDepth({ region: "US", code: "AAPL" });

// Get latest tick
await client.getTick({ region: "US", code: "AAPL" });

// Get K-line data
await client.getKline({
  region: "US",
  code: "AAPL",
  interval: "5m",
  limit: 100,
});

// Batch queries
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 information
await client.getIPO({ region: "US", code: "RIVN" });

// Split factor 
await client.getSplit({ region: "US", code: "AAPL" });

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

const client = new CryptoClient(token);

// Get real-time data
await client.getQuote({ region: "BA", code: "BTCUSDT" });
await client.getDepth({ region: "BA", code: "ETHUSDT" });
await client.getTick({ region: "BA", code: "BTCUSDT" });

// Get K-line data
await client.getKline({
  region: "BA",
  code: "BTCUSDT",
  interval: "1h",
  limit: 100,
});

// Batch queries
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 });

// Connection opened
socket.onSocketOpen(() => {
  console.log("Connected!");
});

// Receive message
socket.onSocketMessage((data) => {
  console.log("Received data:", data);
});

// Error occurred
socket.onSocketError((error) => {
  console.error("Error:", error);
});

// Connection closed
socket.onSocketClose(() => {
  console.log("Disconnected");
});

// Check connection status
const isConnected = socket.checkSocketConnected();

// Disconnect
socket.disconnectSocket();

// Subscribe after connection
socket.subscribeSocket({
  ac: "subscribe",
  types: ["quote", "depth"],
  codes: ["TSLA$US", "NVDA$US"],
});

// Unsubscribe
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 Error:", response.msg);
    return;
  }

  // Process data
  console.log(response.data);
} catch (error) {
  if (error instanceof Error) {
    console.error("Network error:", error.message);
  }
}

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

// Type-safe response
const response: APIResponse<QuoteData> = await client.getQuote({
  region: "US",
  code: "AAPL",
});

// Type-safe WebSocket messages
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;
  }
});