tigeropen-typescript

Tiger Open API TypeScript SDK

老虎量化开放平台 TypeScript SDK 完整技能集 / Complete AI skill set for Tiger Brokers OpenAPI (TypeScript)

安全警告 / Safety Warning: 交易涉及真实资金。生成交易代码时默认使用模拟账户，除非用户明确要求实盘。实盘下单前必须与用户确认订单详情。 Trading involves real money. Default to Paper Trading when generating trading code. Always confirm order details before live orders.

• Docs: https://docs.itigerup.com/docs/prepare
• npm: npm install @tigeropenapi/tigeropen | Node.js 16+, ESM/CommonJS

Language Rules / 语言规则

根据用户输入语言自动回复。技术术语（代码、API 名称、参数名）保持原文不翻译。 Reply in the user's language. Keep technical terms (code, API names, parameters) as-is.

Reference Guides

• [Quickstart](references/quickstart.md) — SDK install, config, client setup, error handling
• [Market Data](references/quote.md) — Real-time quotes, K-lines, depth, options, futures
• [Trading](references/trade.md) — Place/modify/cancel orders, positions, assets
• [Real-time Push](references/push.md) — WebSocket push for quotes, orders, positions
• [Account Management](references/account.md) — Account list, assets, positions, fund transfer, deposit/withdrawal
• [Options Trading](references/option.md) — Option chain, expirations, Greeks, multi-leg strategies

Quick Start

import {
  createClientConfig,
  HttpClient,
  QuoteClient,
  TradeClient,
} from '@tigeropenapi/tigeropen';

// 1. 创建配置 / Create config
const config = createClientConfig({
  tigerId: 'your_tiger_id',
  privateKey: 'your_rsa_private_key',
  account: 'your_account',
});

// 2. 查询行情 / Query quotes（注意：接收请求对象，不是数组）
const httpClient = new HttpClient(config);
const qc = new QuoteClient(httpClient);
const quotes = await qc.getBrief({ symbols: ['AAPL', 'TSLA'] });
console.log(quotes);

// 3. 交易操作 / Trading
const tc = new TradeClient(httpClient, config.account);
const orders = await tc.getOrders({ limit: 20 });
console.log(orders);

When to Use Each Reference

Common Symbols / 常见标的速查

港股 HK

美股 US