@tigeropenapi/tigeropen 0.1.0

package/dist/types/push/push-message.d.ts

@@ -0,0 +1,167 @@
+/**
+ * 推送消息类型定义和数据结构
+ *
+ * 定义 WebSocket 推送消息的类型、主题和数据结构，
+ * 使用 JSON 序列化/反序列化（简化替代 Protobuf）。
+ */
+/** 推送消息类型 */
+export declare enum MessageType {
+    Connect = "connect",
+    Connected = "connected",
+    Disconnect = "disconnect",
+    Heartbeat = "heartbeat",
+    Kickout = "kickout",
+    Error = "error",
+    Subscribe = "subscribe",
+    Unsubscribe = "unsubscribe",
+    Quote = "quote",
+    Tick = "tick",
+    Depth = "depth",
+    Option = "option",
+    Future = "future",
+    Kline = "kline",
+    StockTop = "stock_top",
+    OptionTop = "option_top",
+    FullTick = "full_tick",
+    QuoteBBO = "quote_bbo",
+    Asset = "asset",
+    Position = "position",
+    Order = "order",
+    Transaction = "transaction"
+}
+/** 订阅主题类型 */
+export declare enum SubjectType {
+    Quote = "quote",
+    Tick = "tick",
+    Depth = "depth",
+    Option = "option",
+    Future = "future",
+    Kline = "kline",
+    StockTop = "stock_top",
+    OptionTop = "option_top",
+    FullTick = "full_tick",
+    QuoteBBO = "quote_bbo",
+    Asset = "asset",
+    Position = "position",
+    Order = "order",
+    Transaction = "transaction"
+}
+/** 推送消息通用结构 */
+export interface PushMessage {
+    type: MessageType;
+    subject?: SubjectType | string;
+    data?: unknown;
+}
+/** 连接认证请求 */
+export interface ConnectRequest {
+    tigerId: string;
+    sign: string;
+    timestamp: string;
+    version: string;
+}
+/** 订阅/退订请求 */
+export interface SubscribeRequest {
+    subject: SubjectType;
+    symbols?: string[];
+    account?: string;
+    market?: string;
+}
+/** 行情推送数据 */
+export interface QuoteData {
+    symbol: string;
+    latestPrice?: number;
+    preClose?: number;
+    open?: number;
+    high?: number;
+    low?: number;
+    volume?: number;
+    amount?: number;
+    timestamp?: number;
+}
+/** 逐笔成交推送数据 */
+export interface TickData {
+    symbol: string;
+    price: number;
+    volume: number;
+    type?: string;
+    timestamp?: number;
+}
+/** 价格档位 */
+export interface PriceLevel {
+    price: number;
+    volume: number;
+    count?: number;
+}
+/** 深度行情推送数据 */
+export interface DepthData {
+    symbol: string;
+    asks?: PriceLevel[];
+    bids?: PriceLevel[];
+}
+/** K 线推送数据 */
+export interface KlineData {
+    symbol: string;
+    open: number;
+    high: number;
+    low: number;
+    close: number;
+    volume: number;
+    timestamp?: number;
+}
+/** 资产推送数据 */
+export interface AssetData {
+    account: string;
+    netLiquidation?: number;
+    equityWithLoan?: number;
+    cashBalance?: number;
+    buyingPower?: number;
+    currency?: string;
+}
+/** 持仓推送数据 */
+export interface PositionData {
+    account: string;
+    symbol: string;
+    secType?: string;
+    quantity: number;
+    averageCost?: number;
+    marketPrice?: number;
+    marketValue?: number;
+    unrealizedPnl?: number;
+}
+/** 订单推送数据 */
+export interface OrderData {
+    account: string;
+    id?: number;
+    orderId?: number;
+    symbol: string;
+    action?: string;
+    orderType?: string;
+    quantity?: number;
+    limitPrice?: number;
+    status?: string;
+    filled?: number;
+    avgFillPrice?: number;
+}
+/** 成交推送数据 */
+export interface TransactionData {
+    account: string;
+    id?: number;
+    orderId?: number;
+    symbol: string;
+    action?: string;
+    price?: number;
+    quantity?: number;
+    timestamp?: number;
+}
+/**
+ * 创建推送消息
+ */
+export declare function createPushMessage(type: MessageType, subject?: SubjectType | string, data?: unknown): PushMessage;
+/**
+ * 序列化推送消息为 JSON 字符串
+ */
+export declare function serializeMessage(msg: PushMessage): string;
+/**
+ * 反序列化 JSON 字符串为推送消息
+ */
+export declare function deserializeMessage(data: string): PushMessage;

package/dist/types/quote/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 行情模块导出
+ */
+export { QuoteClient } from './quote-client';

package/dist/types/quote/quote-client.d.ts

@@ -0,0 +1,58 @@
+/**
+ * QuoteClient 行情查询客户端
+ * 封装所有行情相关 API，通过 HttpClient 发送请求
+ */
+import type { HttpClient } from '../client/http-client';
+/**
+ * 行情查询客户端，封装所有行情相关 API。
+ */
+export declare class QuoteClient {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * 内部通用方法：构造请求、发送、返回 data 字段
+     */
+    private execute;
+    /** 获取市场状态 */
+    marketState(market: string): Promise<unknown>;
+    /** 获取实时报价 */
+    quoteRealTime(symbols: string[]): Promise<unknown>;
+    /** 获取 K 线数据 */
+    kline(symbol: string, period: string): Promise<unknown>;
+    /** 获取分时数据 */
+    timeline(symbols: string[]): Promise<unknown>;
+    /** 获取逐笔成交数据 */
+    tradeTick(symbols: string[]): Promise<unknown>;
+    /** 获取深度行情 */
+    quoteDepth(symbol: string): Promise<unknown>;
+    /** 获取期权到期日 */
+    optionExpiration(symbol: string): Promise<unknown>;
+    /** 获取期权链 */
+    optionChain(symbol: string, expiry: string): Promise<unknown>;
+    /** 获取期权报价 */
+    optionBrief(identifiers: string[]): Promise<unknown>;
+    /** 获取期权 K 线 */
+    optionKline(identifier: string, period: string): Promise<unknown>;
+    /** 获取期货交易所列表 */
+    futureExchange(): Promise<unknown>;
+    /** 获取期货合约列表 */
+    futureContracts(exchange: string): Promise<unknown>;
+    /** 获取期货实时报价 */
+    futureRealTimeQuote(symbols: string[]): Promise<unknown>;
+    /** 获取期货 K 线 */
+    futureKline(symbol: string, period: string): Promise<unknown>;
+    /** 获取财务日报 */
+    financialDaily(symbol: string): Promise<unknown>;
+    /** 获取财务报告 */
+    financialReport(symbol: string): Promise<unknown>;
+    /** 获取公司行动 */
+    corporateAction(symbol: string): Promise<unknown>;
+    /** 获取资金流向 */
+    capitalFlow(symbol: string): Promise<unknown>;
+    /** 获取资金分布 */
+    capitalDistribution(symbol: string): Promise<unknown>;
+    /** 选股器 */
+    marketScanner(params: Record<string, unknown>): Promise<unknown>;
+    /** 获取行情权限 */
+    grabQuotePermission(): Promise<unknown>;
+}

package/dist/types/signer/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 认证层（RSA Signer）统一导出
+ */
+export { loadPrivateKey, signWithRSA, verifyWithRSA } from './signer';
+export { getSignContent } from './sign-content';

package/dist/types/signer/sign-content.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 请求参数排序拼接模块
+ *
+ * 按参数名字母序排列所有参数，拼接为 key=value&key=value 格式，
+ * 用于构造 RSA 签名的待签名内容。
+ */
+/**
+ * 按参数名字母序排列所有参数，拼接为 key=value&key=value 格式。
+ *
+ * @param params - 参数名-值映射
+ * @returns 拼接后的字符串
+ */
+export declare function getSignContent(params: Record<string, string>): string;

package/dist/types/signer/signer.d.ts

@@ -0,0 +1,36 @@
+/**
+ * RSA 签名模块
+ *
+ * 提供 RSA 私钥加载、SHA1WithRSA 签名和验签功能。
+ * 支持 PKCS#1、PKCS#8 PEM 格式以及裸 Base64 编码。
+ */
+import { KeyObject } from 'crypto';
+/**
+ * 加载 RSA 私钥，支持以下格式：
+ * - PKCS#1 PEM（BEGIN RSA PRIVATE KEY）
+ * - PKCS#8 PEM（BEGIN PRIVATE KEY）
+ * - 裸 Base64 编码的 DER 数据（无 PEM 头尾）
+ *
+ * @param keyStr - 私钥字符串
+ * @returns KeyObject 私钥对象
+ * @throws 私钥为空或格式无效时抛出错误
+ */
+export declare function loadPrivateKey(keyStr: string): KeyObject;
+/**
+ * 使用 RSA 私钥对内容进行 SHA1WithRSA 签名，返回 Base64 编码的签名字符串。
+ *
+ * @param privateKeyStr - 私钥字符串（支持 PKCS#1/PKCS#8 PEM 或裸 Base64）
+ * @param content - 待签名内容
+ * @returns Base64 编码的签名字符串
+ * @throws 私钥无效或签名失败时抛出错误
+ */
+export declare function signWithRSA(privateKeyStr: string, content: string): string;
+/**
+ * 使用 RSA 公钥验证 SHA1WithRSA 签名。
+ *
+ * @param publicKey - 公钥对象
+ * @param content - 原始内容
+ * @param signature - Base64 编码的签名字符串
+ * @returns 验签是否成功
+ */
+export declare function verifyWithRSA(publicKey: KeyObject, content: string, signature: string): boolean;

package/dist/types/trade/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 交易模块导出
+ */
+export { TradeClient } from './trade-client';

package/dist/types/trade/trade-client.d.ts

@@ -0,0 +1,48 @@
+/**
+ * TradeClient 交易客户端
+ * 封装所有交易相关 API，通过 HttpClient 发送请求
+ */
+import type { HttpClient } from '../client/http-client';
+import type { Order } from '../model/order';
+/**
+ * 交易客户端，封装所有交易相关 API。
+ */
+export declare class TradeClient {
+    private httpClient;
+    private account;
+    constructor(httpClient: HttpClient, account: string);
+    /**
+     * 内部通用方法：构造请求、发送、返回 data 字段
+     */
+    private execute;
+    /** 查询单个合约 */
+    contract(symbol: string, secType: string): Promise<unknown>;
+    /** 批量查询合约 */
+    contracts(symbols: string[], secType: string): Promise<unknown>;
+    /** 查询衍生品合约 */
+    quoteContract(symbol: string, secType: string): Promise<unknown>;
+    /** 下单 */
+    placeOrder(order: Order): Promise<unknown>;
+    /** 预览订单 */
+    previewOrder(order: Order): Promise<unknown>;
+    /** 修改订单 */
+    modifyOrder(id: number, order: Order): Promise<unknown>;
+    /** 取消订单 */
+    cancelOrder(id: number): Promise<unknown>;
+    /** 查询全部订单 */
+    orders(): Promise<unknown>;
+    /** 查询待成交订单 */
+    activeOrders(): Promise<unknown>;
+    /** 查询已撤销订单 */
+    inactiveOrders(): Promise<unknown>;
+    /** 查询已成交订单 */
+    filledOrders(): Promise<unknown>;
+    /** 查询持仓 */
+    positions(): Promise<unknown>;
+    /** 查询资产 */
+    assets(): Promise<unknown>;
+    /** 查询综合账户资产 */
+    primeAssets(): Promise<unknown>;
+    /** 查询订单成交明细 */
+    orderTransactions(id: number): Promise<unknown>;
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@tigeropenapi/tigeropen",
+  "version": "0.1.0",
+  "description": "老虎证券 OpenAPI TypeScript SDK",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tigerfintech/openapi-typescript-sdk.git"
+  },
+  "homepage": "https://github.com/tigerfintech/openapi-typescript-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/tigerfintech/openapi-typescript-sdk/issues"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "prepublishOnly": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "rm -rf dist"
+  },
+  "keywords": [
+    "tiger",
+    "openapi",
+    "sdk",
+    "trading",
+    "stock"
+  ],
+  "author": "Tiger Fintech",
+  "license": "MIT",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "devDependencies": {
+    "@types/ws": "^8.5.0",
+    "fast-check": "^3.15.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.2.0",
+    "ws": "^8.16.0"
+  }
+}