@tigeropenapi/tigeropen 0.4.9 → 0.5.3

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

@@ -121,6 +121,26 @@ export interface OptionChainRow {
     put?: OptionLeg;
     call?: OptionLeg;
 }
+/** Range filter, serialized as { min, max } — corresponds to Java Range<T> */
+export interface Range {
+    min?: number;
+    max?: number;
+}
+/** Greeks range filters for option_chain (corresponds to Java OptionChainFilterModel.Greeks) */
+export interface OptionChainFilterGreeks {
+    delta?: Range;
+    gamma?: Range;
+    vega?: Range;
+    theta?: Range;
+    rho?: Range;
+}
+/** Option chain filter (corresponds to Java OptionChainFilterModel) */
+export interface OptionChainFilter {
+    inTheMoney?: boolean;
+    impliedVolatility?: Range;
+    openInterest?: Range;
+    greeks?: OptionChainFilterGreeks;
+}
 export interface OptionChain {
     symbol: string;
     expiry: number;
@@ -217,6 +237,42 @@ export interface CorporateAction {
     fromFactor?: number;
     toFactor?: number;
 }
+export interface CorporateSymbolChange {
+    symbol: string;
+    market?: string;
+    exchange?: string;
+    executeDate?: string;
+    actionType?: string;
+    oldSymbol?: string;
+    /** newSymbol is the ticker after the rename; same as symbol. */
+    newSymbol?: string;
+}
+export interface CorporateDelisting {
+    symbol: string;
+    market?: string;
+    exchange?: string;
+    executeDate?: string;
+    actionType?: string;
+    announcedDate?: string;
+    reason?: string;
+}
+export interface CorporateIPO {
+    symbol: string;
+    market?: string;
+    exchange?: string;
+    executeDate?: string;
+    actionType?: string;
+    ipoName?: string;
+    listingDate?: string;
+    listingPrice?: number;
+    sharesOutstanding?: number;
+    sharesFloat?: number;
+    offerAmount?: number;
+    priceRange?: string;
+    currency?: string;
+    minPurchaseQuantity?: number;
+    leverageRatio?: number;
+}
 export interface CapitalFlowItem {
     time: string;
     timestamp: number;
@@ -407,16 +463,26 @@ export interface KlineQuota {
 }
 /** Option historical-volatility time series point. */
 export interface OptionVolatilityPoint {
-    date?: string;
-    volatility?: number;
+    impliedVol?: number;
+    percentile?: number;
+    rank?: number;
+    hisVolatility?: number;
+    timestamp?: number;
+}
+/** Implied-volatility metric for a specific period. */
+export interface ImpliedVolMetric {
+    period?: string;
+    percentile?: number;
+    rank?: number;
 }
 /** Option analysis (option_analysis). */
 export interface OptionAnalysis {
     symbol?: string;
-    historicalVolatility30Day?: number;
-    historicalVolatility60Day?: number;
-    historicalVolatility90Day?: number;
-    impliedVolatility?: number;
+    impliedVol30Days?: number;
+    hisVolatility?: number;
+    ivHisVRatio?: number;
+    callPutRatio?: number;
+    impliedVolMetric?: ImpliedVolMetric;
     volatilityList?: OptionVolatilityPoint[];
 }
 /** Option symbol listing (option_symbol). */
@@ -541,11 +607,14 @@ export interface MarketScannerTag {
     name?: string;
     values?: string[];
 }
-/** Market scanner tag set (market_scanner_tags). */
-export interface MarketScannerTags {
-    tagFields?: string[];
-    tags?: MarketScannerTag[];
+/** Market-scanner tag group (one entry per market). wire: market_scanner_tags returns array of these. */
+export interface MarketScannerTagGroup {
+    market?: string;
+    multiTagField?: string;
+    tagList?: MarketScannerTag[];
 }
+/** @deprecated Use MarketScannerTagGroup[] instead. Kept for backwards compatibility. */
+export type MarketScannerTags = MarketScannerTagGroup;
 /** Fund contract info (fund_contracts). */
 export interface FundContractInfo {
     symbol?: string;

package/dist/types/model/trade-requests.d.ts

@@ -11,6 +11,8 @@
  */
 export interface OrdersRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     secType?: string;
     market?: string;
     symbol?: string;
@@ -32,6 +34,8 @@ export interface OrdersRequest {
 }
 export interface GetOrderRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     id?: number;
     orderId?: number;
     isBrief?: boolean;
@@ -40,6 +44,8 @@ export interface GetOrderRequest {
 }
 export interface OrderTransactionsRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     orderId?: number;
     symbol?: string;
     secType?: string;
@@ -56,6 +62,8 @@ export interface OrderTransactionsRequest {
 }
 export interface PositionsRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     secType?: string;
     currency?: string;
     market?: string;
@@ -69,6 +77,8 @@ export interface PositionsRequest {
 }
 export interface AssetsRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     subAccounts?: string[];
     segment?: boolean;
     marketValue?: boolean;
@@ -76,10 +86,14 @@ export interface AssetsRequest {
 }
 export interface ManagedAccountsRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     lang?: string;
 }
 export interface DerivativeContractsRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     symbols: string[];
     secType: string;
     expiry?: string;
@@ -87,6 +101,8 @@ export interface DerivativeContractsRequest {
 }
 export interface AnalyticsAssetRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     segType?: string;
     /** 格式 "YYYY-MM-DD" */
     startDate?: string;
@@ -95,12 +111,16 @@ export interface AnalyticsAssetRequest {
 }
 export interface AggregateAssetsRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     baseCurrency?: string;
     segType?: string;
     lang?: string;
 }
 export interface EstimateTradableQuantityRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     symbol: string;
     secType: string;
     action: string;
@@ -115,6 +135,8 @@ export interface EstimateTradableQuantityRequest {
 }
 export interface ForexOrderRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     segType?: string;
     sourceCurrency: string;
     targetCurrency: string;
@@ -125,6 +147,8 @@ export interface ForexOrderRequest {
 }
 export interface SegmentFundRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     id?: string;
     fromSegment?: string;
     toSegment?: string;
@@ -135,6 +159,8 @@ export interface SegmentFundRequest {
 }
 export interface FundDetailsRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     segTypes?: string[];
     fundType?: string;
     currency?: string;
@@ -148,6 +174,8 @@ export interface FundDetailsRequest {
 }
 export interface FundingHistoryRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     segType?: string;
     currency?: string;
     /** 毫秒时间戳 */
@@ -159,6 +187,8 @@ export interface FundingHistoryRequest {
 }
 export interface PositionTransferRequest {
     fromAccount?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     toAccount: string;
     market?: string;
     transfers: Array<{
@@ -174,6 +204,8 @@ export interface PositionTransferRequest {
 export interface PositionTransferRecordsRequest {
     /** wire: account_id */
     accountId?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     sinceDate?: string;
     toDate?: string;
     market?: string;
@@ -182,11 +214,15 @@ export interface PositionTransferRecordsRequest {
 }
 export interface PositionTransferDetailRequest {
     accountId?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     id: string;
     lang?: string;
 }
 export interface PositionTransferExternalRecordsRequest {
     accountId?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
+    secretKey?: string;
     sinceDate?: string;
     toDate?: string;
     market?: string;
@@ -196,6 +232,7 @@ export interface PositionTransferExternalRecordsRequest {
 /** 行权检验请求 (wire: option_exercise_check) */
 export interface OptionExerciseCheckRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
     secretKey?: string;
     /** 期权合约 ID */
     contractId: number;
@@ -213,6 +250,7 @@ export interface OptionExerciseCheckRequest {
 /** 查询可行权持仓请求 (wire: option_exercise_position) */
 export interface OptionExercisePositionRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
     secretKey?: string;
     /** Exercise | Expire */
     type: string;
@@ -221,6 +259,7 @@ export interface OptionExercisePositionRequest {
 /** 提交行权申请请求 (wire: option_exercise_submit) */
 export interface OptionExerciseSubmitRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
     secretKey?: string;
     contractId: number;
     /** Exercise | Expire */
@@ -237,6 +276,7 @@ export interface OptionExerciseSubmitRequest {
 /** 分页查询行权记录请求 (wire: option_exercise_record) */
 export interface OptionExerciseRecordsRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
     secretKey?: string;
     /** 从 1 开始，默认 1 */
     page?: number;
@@ -254,6 +294,7 @@ export interface OptionExerciseRecordsRequest {
 /** 撤销行权申请请求 (wire: option_exercise_cancel) */
 export interface OptionExerciseCancelRequest {
     account?: string;
+    /** Institution account secret key. Overrides the default set in ClientConfig; omit to use the config default. */
     secretKey?: string;
     id: number;
     lang?: string;

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

@@ -203,7 +203,8 @@ export interface SegmentFundHistoryItem {
     updatedAt?: number;
 }
 export interface FundDetails {
-    id?: number;
+    /** int64 fund-detail ID — server may return as string (e.g. "4733519770"). */
+    id?: string | number;
     account?: string;
     segType?: string;
     fundType?: string;

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

@@ -7,7 +7,7 @@
  */
 import { HttpClient } from '../client/http-client';
 import type { ClientConfig } from '../config/client-config';
-import type { MarketState, Brief, Kline, KlineItem, Timeline, TradeTick, Depth, OptionExpiration, OptionChain, FutureExchange, FutureContractInfo, FutureQuote, FutureKline, FutureKlineItem, FinancialDailyItem, FinancialReportItem, CorporateAction, CapitalFlow, CapitalDistribution, ScannerResult, QuotePermission, MarketScannerRequest, SymbolName, TradeMeta, StockDetail, StockBroker, StockIndustry, TradeRankItem, ShortInterest, KlineQuota, OptionAnalysis, OptionSymbol, FutureMainContractHistory, FutureTradingTime, FutureTradeTickItem, FutureDepth, WarrantBrief, WarrantFilterResult, IndustryItem, IndustryStock, TradingCalendarItem, ExchangeRate, FinancialCurrency, QuoteOvernight, MarketScannerTags, FundContractInfo, FundQuote, FundHistoryQuote, FinancialDailyRequest, FinancialReportRequest, CorporateActionRequest } from '../model/quote';
+import type { MarketState, Brief, Kline, KlineItem, Timeline, TradeTick, Depth, OptionExpiration, OptionChain, OptionChainFilter, FutureExchange, FutureContractInfo, FutureQuote, FutureKline, FutureKlineItem, FinancialDailyItem, FinancialReportItem, CorporateAction, CorporateSymbolChange, CorporateDelisting, CorporateIPO, CapitalFlow, CapitalDistribution, ScannerResult, QuotePermission, MarketScannerRequest, SymbolName, TradeMeta, StockDetail, StockBroker, StockIndustry, TradeRankItem, ShortInterest, KlineQuota, OptionAnalysis, OptionSymbol, FutureMainContractHistory, FutureTradingTime, FutureTradeTickItem, FutureDepth, WarrantBrief, WarrantFilterResult, IndustryItem, IndustryStock, TradingCalendarItem, ExchangeRate, FinancialCurrency, QuoteOvernight, MarketScannerTagGroup, FundContractInfo, FundQuote, FundHistoryQuote, FinancialDailyRequest, FinancialReportRequest, CorporateActionRequest } from '../model/quote';
 import type { BriefRequest, DepthQuoteRequest, TradeTickRequest, FutureBriefRequest, SymbolsRequest, TradeMetasRequest, StockDetailsRequest, StockDelayBriefsRequest, KlineRequest, KlineByPageRequest, TimelineHistoryRequest, TradeRankRequest, ShortInterestRequest, StockBrokerRequest, StockFundamentalRequest, StockIndustryRequest, KlineQuotaRequest, QuotePermissionRequest, OptionTradeTicksRequest, OptionTimelineRequest, OptionDepthRequest, OptionSymbolsRequest, OptionAnalysisRequest, FutureContractSingleRequest, AllFutureContractsRequest, FutureContinuousContractsRequest, FutureHistoryMainContractRequest, FutureKlineRequest, FutureKlineByPageRequest, FutureTradeTicksRequest, FutureDepthRequest, FutureTradingTimesRequest, FundSymbolsRequest, FundContractsRequest, FundQuoteRequest, FundHistoryQuoteRequest, WarrantBriefsRequest, WarrantFilterRequest, IndustryListRequest, IndustryStocksRequest, TradingCalendarRequest, FinancialExchangeRateRequest, FinancialCurrencyRequest, MarketScannerTagsRequest, QuoteOvernightRequest } from '../model/quote-requests';
 /**
  * Parse an OCC-style option identifier like "AAPL  260619C00150000"
@@ -54,24 +54,28 @@ export declare class QuoteClient {
      *
      * @param timezone - Optional IANA timezone for expiry conversion (e.g. 'America/New_York').
      *   If omitted, defaults to America/New_York for US symbols and Asia/Hong_Kong for .HK symbols.
+     * @param returnGreekValue - Whether to return Greeks (delta/gamma/theta/vega/rho).
+     * @param optionFilter - Optional filter for in-the-money status, IV range, open interest range, Greeks ranges.
      */
-    getOptionChain(items: Array<[string, string]>, timezone?: string): Promise<OptionChain[]>;
+    getOptionChain(items: Array<[string, string]>, timezone?: string, returnGreekValue?: boolean, optionFilter?: OptionChainFilter): Promise<OptionChain[]>;
     /**
-     * Real-time option quotes by OCC-style identifier.
+     * Option K-line by OCC-style identifier.
      *
      * @param timezone - Optional IANA timezone for expiry conversion (e.g. 'America/New_York').
      *   If omitted, defaults to America/New_York for US symbols and Asia/Hong_Kong for .HK symbols.
+     * @param limit - Maximum number of bars to return.
+     * @param sortDir - Sort direction ('asc' or 'desc').
      */
-    getOptionQuote(identifiers: string[], timezone?: string): Promise<Brief[]>;
-    /** @deprecated Use getOptionQuote instead. */
-    getOptionBrief(identifiers: string[]): Promise<Brief[]>;
+    getOptionKline(identifiers: string[], period: string, beginTime?: number, endTime?: number, timezone?: string, limit?: number, sortDir?: string): Promise<Kline[]>;
     /**
-     * Option K-line by OCC-style identifier.
+     * Real-time option quotes by OCC-style identifier.
      *
      * @param timezone - Optional IANA timezone for expiry conversion (e.g. 'America/New_York').
      *   If omitted, defaults to America/New_York for US symbols and Asia/Hong_Kong for .HK symbols.
      */
-    getOptionKline(identifiers: string[], period: string, beginTime?: number, endTime?: number, timezone?: string): Promise<Kline[]>;
+    getOptionQuote(identifiers: string[], timezone?: string): Promise<Brief[]>;
+    /** @deprecated Use getOptionQuote instead. */
+    getOptionBrief(identifiers: string[]): Promise<Brief[]>;
     getFutureExchange(): Promise<FutureExchange[]>;
     getFutureContracts(exchange: string): Promise<FutureContractInfo[]>;
     /** Real-time futures quotes. wire: future_real_time_quote */
@@ -173,6 +177,12 @@ export declare class QuoteClient {
     getCorporateDividend(req: CorporateActionRequest): Promise<CorporateAction[]>;
     /** Corporate earnings calendar (flattened). wire: corporate_action (action_type=earning) */
     getCorporateEarningsCalendar(req: CorporateActionRequest): Promise<CorporateAction[]>;
+    /** Corporate symbol change (flattened). wire: corporate_action (action_type=symbol_change) */
+    getCorporateSymbolChange(req: Omit<CorporateActionRequest, 'actionType'>): Promise<CorporateSymbolChange[]>;
+    /** Corporate delisting (flattened). wire: corporate_action (action_type=delisting) */
+    getCorporateDelisting(req: Omit<CorporateActionRequest, 'actionType'>): Promise<CorporateDelisting[]>;
+    /** Corporate IPO (flattened). wire: corporate_action (action_type=ipo) */
+    getCorporateIPO(req: Omit<CorporateActionRequest, 'actionType'>): Promise<CorporateIPO[]>;
     /** Financial currency per symbol. wire: financial_currency */
     getFinancialCurrency(req: FinancialCurrencyRequest): Promise<FinancialCurrency[]>;
     /** FX rates. wire: financial_exchange_rate */
@@ -180,7 +190,7 @@ export declare class QuoteClient {
     /** Trading calendar. wire: trading_calendar */
     getTradingCalendar(req: TradingCalendarRequest): Promise<TradingCalendarItem[]>;
     /** Available market-scanner tags. wire: market_scanner_tags */
-    getMarketScannerTags(req: MarketScannerTagsRequest): Promise<MarketScannerTags | undefined>;
+    getMarketScannerTags(req: MarketScannerTagsRequest): Promise<MarketScannerTagGroup[]>;
     /** Overnight quote. wire: quote_overnight */
     getQuoteOvernight(req: QuoteOvernightRequest): Promise<QuoteOvernight[]>;
 }

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

@@ -62,9 +62,6 @@ export declare class TradeClient {
     getFilledOrders(req?: OrdersRequest): Promise<Order[]>;
     /**
      * Get a single order by ID (v0.4.0 new).
-     * Wire method: `orders` with id/order_id param; server returns a single Order object
-     * (not `{items:[]}` envelope).
-     *
      * Returns `undefined` if no match.
      */
     getOrder(req: GetOrderRequest): Promise<Order | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tigeropenapi/tigeropen",
-  "version": "0.4.9",
+  "version": "0.5.3",
   "description": "Tiger Brokers OpenAPI TypeScript SDK for market data, trading, and real-time push",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",