@tigeropenapi/tigeropen 0.1.0 → 0.3.0

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

@@ -1,58 +1,52 @@
 /**
- * QuoteClient 行情查询客户端
- * 封装所有行情相关 API，通过 HttpClient 发送请求
+ * QuoteClient — market-data client.
+ *
+ * All methods return strongly-typed responses from the `model` package.
+ * Request parameters are written in camelCase in TypeScript and are
+ * converted to snake_case on the wire automatically.
  */
 import type { HttpClient } from '../client/http-client';
+import type { MarketState, Brief, Kline, Timeline, TradeTick, Depth, OptionExpiration, OptionChain, FutureExchange, FutureContractInfo, FutureQuote, FutureKline, FinancialDailyItem, FinancialReportItem, CorporateAction, CapitalFlow, CapitalDistribution, ScannerResult, QuotePermission, FinancialDailyRequest, FinancialReportRequest, CorporateActionRequest, FutureKlineRequest, MarketScannerRequest } from '../model/quote';
 /**
- * 行情查询客户端，封装所有行情相关 API。
+ * Parse an OCC-style option identifier like "AAPL  260619C00150000"
+ * into its component parts.
  */
+export declare function parseOptionIdentifier(identifier: string): {
+    symbol: string;
+    expiryMs: number;
+    right: string;
+    strike: number;
+};
+/** Market data client wrapping all quote-related APIs. */
 export declare class QuoteClient {
     private httpClient;
     constructor(httpClient: HttpClient);
+    private callInto;
+    getMarketState(market: string): Promise<MarketState[]>;
+    getBrief(symbols: string[]): Promise<Brief[]>;
+    getKline(symbol: string, period: string): Promise<Kline[]>;
+    getTimeline(symbols: string[]): Promise<Timeline[]>;
+    getTradeTick(symbols: string[]): Promise<TradeTick[]>;
+    /** Depth snapshot. market is required (US / HK supported). */
+    getQuoteDepth(symbol: string, market: string): Promise<Depth[]>;
+    getOptionExpiration(symbol: string): Promise<OptionExpiration[]>;
+    /** Option chain; `expiry` is "YYYY-MM-DD". */
+    getOptionChain(symbol: string, expiry: string): Promise<OptionChain[]>;
+    getOptionBrief(identifiers: string[]): Promise<Brief[]>;
+    getOptionKline(identifier: string, period: string): Promise<Kline[]>;
+    getFutureExchange(): Promise<FutureExchange[]>;
+    getFutureContracts(exchange: string): Promise<FutureContractInfo[]>;
+    getFutureRealTimeQuote(contractCodes: string[]): Promise<FutureQuote[]>;
+    /** Futures K-line; use -1 for unbounded beginTime / endTime. */
+    getFutureKline(req: FutureKlineRequest): Promise<FutureKline[]>;
+    getFinancialDaily(req: FinancialDailyRequest): Promise<FinancialDailyItem[]>;
+    getFinancialReport(req: FinancialReportRequest): Promise<FinancialReportItem[]>;
     /**
-     * 内部通用方法：构造请求、发送、返回 data 字段
+     * Corporate actions. Server returns {symbol: [...]}, this method flattens into a single list.
      */
-    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>;
+    getCorporateAction(req: CorporateActionRequest): Promise<CorporateAction[]>;
+    getCapitalFlow(symbol: string, market: string, period: string): Promise<CapitalFlow | undefined>;
+    getCapitalDistribution(symbol: string, market: string): Promise<CapitalDistribution | undefined>;
+    marketScanner(req: MarketScannerRequest): Promise<ScannerResult | undefined>;
+    grabQuotePermission(): Promise<QuotePermission[]>;
 }

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

@@ -26,11 +26,11 @@ export declare function loadPrivateKey(keyStr: string): KeyObject;
  */
 export declare function signWithRSA(privateKeyStr: string, content: string): string;
 /**
- * 使用 RSA 公钥验证 SHA1WithRSA 签名。
+ * Verify a SHA1WithRSA signature using an RSA public key.
  *
- * @param publicKey - 公钥对象
- * @param content - 原始内容
- * @param signature - Base64 编码的签名字符串
- * @returns 验签是否成功
+ * @param publicKeyBase64 - Base64-encoded public key (DER / PKCS#1 or SPKI)
+ * @param content - Original content that was signed
+ * @param signatureBase64 - Base64-encoded signature
+ * @returns Whether the signature is valid
  */
-export declare function verifyWithRSA(publicKey: KeyObject, content: string, signature: string): boolean;
+export declare function verifyWithRSA(publicKeyBase64: string, content: string, signatureBase64: string): boolean;

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

@@ -1,48 +1,44 @@
 /**
- * TradeClient 交易客户端
- * 封装所有交易相关 API，通过 HttpClient 发送请求
+ * TradeClient — trading client.
+ *
+ * All methods return strongly-typed responses; request parameters are
+ * written in camelCase in TypeScript and converted to snake_case on the wire.
  */
 import type { HttpClient } from '../client/http-client';
-import type { Order } from '../model/order';
-/**
- * 交易客户端，封装所有交易相关 API。
- */
+import type { OrderRequest, Order } from '../model/order';
+import type { Contract } from '../model/contract';
+import type { Position } from '../model/position';
+import type { Asset, PrimeAsset, PreviewResult, PlaceOrderResult, OrderIdResult, Transaction } from '../model/trade';
+/** Trading client wrapping all trade-related APIs. */
 export declare class TradeClient {
     private httpClient;
     private account;
     constructor(httpClient: HttpClient, account: string);
+    private callInto;
+    /** Strip `{items: [...]}` envelope used by most trade read endpoints. */
+    private callIntoItems;
+    getContract(symbol: string, secType: string): Promise<Contract[]>;
+    getContracts(symbols: string[], secType: string): Promise<Contract[]>;
+    /**
+     * Derivative contracts (OPT / WAR / IOPT only).
+     * `symbol` is the underlying (e.g. "AAPL"); `expiry` is "YYYYMMDD".
+     */
+    getQuoteContract(symbol: string, secType: string, expiry: string): Promise<Contract[]>;
+    placeOrder(order: OrderRequest): Promise<PlaceOrderResult | undefined>;
+    previewOrder(order: OrderRequest): Promise<PreviewResult | undefined>;
+    modifyOrder(id: number, order: OrderRequest): Promise<OrderIdResult | undefined>;
+    cancelOrder(id: number): Promise<OrderIdResult | undefined>;
+    getOrders(): Promise<Order[]>;
+    getActiveOrders(): Promise<Order[]>;
+    getInactiveOrders(): Promise<Order[]>;
     /**
-     * 内部通用方法：构造请求、发送、返回 data 字段
+     * Filled orders in a time range (ms timestamps required by the server).
+     * Use `Date.now() - 30*24*3600*1000` for "last 30 days".
      */
-    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>;
+    getFilledOrders(startDateMs: number, endDateMs: number): Promise<Order[]>;
+    /** Transactions for a specific order; `symbol` and `secType` are required. */
+    getOrderTransactions(id: number, symbol: string, secType: string): Promise<Transaction[]>;
+    getPositions(): Promise<Position[]>;
+    getAssets(): Promise<Asset[]>;
+    getPrimeAssets(): Promise<PrimeAsset | undefined>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tigeropenapi/tigeropen",
-  "version": "0.1.0",
-  "description": "老虎证券 OpenAPI TypeScript SDK",
+  "version": "0.3.0",
+  "description": "Tiger Brokers OpenAPI TypeScript SDK for market data, trading, and real-time push",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
@@ -28,9 +28,11 @@
     "build:esm": "tsc -p tsconfig.json",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "prepublishOnly": "npm run build",
+    "publish:all": "npm run build && npm publish --registry https://registry.npmjs.org --access public && npm pkg set name=tigeropen && npm publish --registry https://registry.npmjs.org && npm pkg set name=@tigeropenapi/tigeropen",
     "test": "vitest run",
     "test:watch": "vitest",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "proto:generate": "protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=./src/push/pb --ts_proto_opt=esModuleInterop=true,outputEncodeMethods=true,outputJsonMethods=false,outputClientImpl=false -I=./proto ./proto/*.proto"
   },
   "keywords": [
     "tiger",
@@ -45,10 +47,13 @@
     "node": ">=16.0.0"
   },
   "devDependencies": {
-    "@types/ws": "^8.5.0",
+    "@types/node": "^25.6.0",
     "fast-check": "^3.15.0",
+    "ts-proto": "^2.11.6",
     "typescript": "^5.3.0",
-    "vitest": "^1.2.0",
-    "ws": "^8.16.0"
+    "vitest": "^1.2.0"
+  },
+  "dependencies": {
+    "@bufbuild/protobuf": "^2.12.0"
   }
 }