@tigeropenapi/tigeropen 0.3.0 → 0.4.5

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

@@ -309,3 +309,264 @@ export interface MarketScannerRequest {
     sortFieldData?: Record<string, unknown>;
     multiTagsFields?: string[];
 }
+/** Symbol + name item (all_symbol_names). */
+export interface SymbolName {
+    symbol?: string;
+    name?: string;
+    market?: string;
+}
+/** Trade meta (quote_stock_trade). */
+export interface TradeMeta {
+    symbol?: string;
+    lotSize?: number;
+    minTick?: number;
+    spreadScale?: number;
+    shortableFlag?: string;
+    marginableFlag?: string;
+}
+/** Stock detail (stock_detail). */
+export interface StockDetail {
+    symbol?: string;
+    nameCN?: string;
+    nameEN?: string;
+    exchange?: string;
+    market?: string;
+    currency?: string;
+    secType?: string;
+    sector?: string;
+    industry?: string;
+    /** ms timestamp */
+    listingDate?: number;
+    marketCap?: number;
+    circulationCap?: number;
+    totalShares?: number;
+    epsTtm?: number;
+    peRatioTtm?: number;
+}
+/** Short interest data. */
+export interface ShortInterest {
+    symbol?: string;
+    settlementDate?: string;
+    shortInterest?: number;
+    avgDailyVolume?: number;
+    daysToCover?: number;
+    percentOfFloat?: number;
+    shortInterestPrevious?: number;
+    percentChange?: number;
+}
+/** Broker detail inside a price level. */
+export interface BrokerDetail {
+    id?: string;
+    name?: string;
+}
+/** A single broker-queue level. */
+export interface StockBrokerItem {
+    level?: number;
+    price?: number;
+    brokers?: BrokerDetail[];
+}
+/** Broker queue (stock_broker). */
+export interface StockBroker {
+    symbol?: string;
+    levelAskList?: StockBrokerItem[];
+    levelBidList?: StockBrokerItem[];
+}
+/** Stock industry classification (stock_industry). */
+export interface StockIndustry {
+    symbol?: string;
+    gsector?: string;
+    ggroup?: string;
+    gind?: string;
+    gsubind?: string;
+    level?: string;
+}
+/** Trade rank row (trade_rank). */
+export interface TradeRankItem {
+    symbol?: string;
+    name?: string;
+    latestPrice?: number;
+    change?: number;
+    changeRate?: number;
+    volume?: number;
+    amount?: number;
+}
+/** K-line quota detail. */
+export interface KlineQuotaDetail {
+    symbol?: string;
+    market?: string;
+    usedBars?: number;
+    quotaBars?: number;
+    lastAccess?: number;
+}
+/** K-line quota (kline_quota). */
+export interface KlineQuota {
+    method?: string;
+    used?: number;
+    quota?: number;
+    detail?: KlineQuotaDetail[];
+}
+/** Option historical-volatility time series point. */
+export interface OptionVolatilityPoint {
+    date?: string;
+    volatility?: number;
+}
+/** Option analysis (option_analysis). */
+export interface OptionAnalysis {
+    symbol?: string;
+    historicalVolatility30Day?: number;
+    historicalVolatility60Day?: number;
+    historicalVolatility90Day?: number;
+    impliedVolatility?: number;
+    volatilityList?: OptionVolatilityPoint[];
+}
+/** Option symbol listing (option_symbol). */
+export interface OptionSymbol {
+    symbol?: string;
+    market?: string;
+    nameCN?: string;
+    nameEN?: string;
+}
+/** Historical futures main contract entry. */
+export interface FutureMainContractHistory {
+    contractCode?: string;
+    symbol?: string;
+    beginDate?: string;
+    endDate?: string;
+}
+/** A single futures trading time segment. */
+export interface FutureTradingSegment {
+    /** ms timestamp */
+    start?: number;
+    end?: number;
+    /** RTH / Night / Break */
+    type?: string;
+}
+/** Futures trading session (future_trading_date). */
+export interface FutureTradingTime {
+    contractCode?: string;
+    bizDate?: string;
+    zone?: string;
+    tradingTimes?: FutureTradingSegment[];
+}
+/** Futures tick-trade item (future_tick). */
+export interface FutureTradeTickItem {
+    contractCode?: string;
+    index?: number;
+    time?: number;
+    price?: number;
+    volume?: number;
+    direction?: string;
+}
+/** Futures depth snapshot (future_depth). */
+export interface FutureDepth {
+    contractCode?: string;
+    timestamp?: number;
+    asks?: DepthLevel[];
+    bids?: DepthLevel[];
+}
+/** Warrant brief (warrant_briefs). */
+export interface WarrantBrief {
+    symbol?: string;
+    name?: string;
+    latestPrice?: number;
+    change?: number;
+    changeRate?: number;
+    volume?: number;
+    amount?: number;
+    underlying?: string;
+    issuer?: string;
+    expiryDate?: string;
+    strikePrice?: number;
+    warrantType?: string;
+}
+/** Warrant filter paged result (warrant_filter). */
+export interface WarrantFilterResult {
+    total?: number;
+    items?: WarrantBrief[];
+    pageSize?: number;
+    page?: number;
+}
+/** Industry list row (industry_list). */
+export interface IndustryItem {
+    id?: string;
+    name?: string;
+    level?: string;
+}
+/** Stock belonging to an industry (industry_stock_list). */
+export interface IndustryStock {
+    symbol?: string;
+    name?: string;
+    industryId?: string;
+    change?: number;
+    changeRate?: number;
+}
+/** Trading calendar entry (trading_calendar). */
+export interface TradingCalendarItem {
+    market?: string;
+    date?: string;
+    isTrading?: boolean;
+    sessionType?: string;
+}
+/** FX rate (financial_exchange_rate). */
+export interface ExchangeRate {
+    currency?: string;
+    date?: string;
+    rate?: number;
+    baseCurrency?: string;
+}
+/** Financial currency per symbol (financial_currency). */
+export interface FinancialCurrency {
+    symbol?: string;
+    market?: string;
+    currency?: string;
+}
+/** Overnight quote (quote_overnight). */
+export interface QuoteOvernight {
+    symbol?: string;
+    preClose?: number;
+    open?: number;
+    close?: number;
+    high?: number;
+    low?: number;
+    volume?: number;
+    amount?: number;
+    change?: number;
+    changeRate?: number;
+    beginTime?: number;
+    endTime?: number;
+}
+/** Single market-scanner tag. */
+export interface MarketScannerTag {
+    field?: string;
+    name?: string;
+    values?: string[];
+}
+/** Market scanner tag set (market_scanner_tags). */
+export interface MarketScannerTags {
+    tagFields?: string[];
+    tags?: MarketScannerTag[];
+}
+/** Fund contract info (fund_contracts). */
+export interface FundContractInfo {
+    symbol?: string;
+    name?: string;
+    currency?: string;
+    fundType?: string;
+    inception?: string;
+    netAssetValue?: number;
+    expenseRatio?: number;
+}
+/** Fund real-time NAV (fund_quote). */
+export interface FundQuote {
+    symbol?: string;
+    latestNav?: number;
+    change?: number;
+    changeRate?: number;
+    date?: string;
+}
+/** Fund historical NAV (fund_history_quote). */
+export interface FundHistoryQuote {
+    symbol?: string;
+    date?: string;
+    nav?: number;
+}

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

@@ -0,0 +1,260 @@
+/**
+ * Trade request interfaces (v0.4.0).
+ *
+ * 所有字段可选(用户调用时传一个空对象即可);字段名用 camelCase,
+ * client 层通过 keysToSnakeCase 转成服务端 wire 真名的 snake_case。
+ * **字段名设计规则:camelCase → snake_case 后必须等于服务端 wire 真名。**
+ * 比如 Trade 用 `startDate`/`endDate`(wire `start_date`/`end_date`),
+ * 不用 `startTime`/`endTime`(会被转成 `start_time`/`end_time`,与 wire 不符)。
+ *
+ * 参考 Go SDK model/trade_requests.go。
+ */
+export interface OrdersRequest {
+    account?: string;
+    secType?: string;
+    market?: string;
+    symbol?: string;
+    /** 毫秒时间戳 (wire: start_date) */
+    startDate?: number;
+    /** 毫秒时间戳 (wire: end_date) */
+    endDate?: number;
+    limit?: number;
+    isBrief?: boolean;
+    /** 订单状态过滤: Invalid / Initial / PendingCancel / Cancelled / Submitted / Filled / Inactive / PendingSubmit */
+    states?: string[];
+    /** LATEST_CREATED / LATEST_STATUS_UPDATED */
+    sortBy?: string;
+    segType?: string;
+    lang?: string;
+    pageToken?: string;
+    /** 仅 ActiveOrders 使用,按父订单 ID 过滤附加订单 */
+    parentId?: number;
+}
+export interface GetOrderRequest {
+    account?: string;
+    id?: number;
+    orderId?: number;
+    isBrief?: boolean;
+    showCharges?: boolean;
+    lang?: string;
+}
+export interface OrderTransactionsRequest {
+    account?: string;
+    orderId?: number;
+    symbol?: string;
+    secType?: string;
+    /** 毫秒时间戳 */
+    startDate?: number;
+    /** 毫秒时间戳 */
+    endDate?: number;
+    limit?: number;
+    expiry?: string;
+    strike?: number;
+    putCall?: string;
+    lang?: string;
+    pageToken?: string;
+}
+export interface PositionsRequest {
+    account?: string;
+    secType?: string;
+    currency?: string;
+    market?: string;
+    symbol?: string;
+    subAccounts?: string[];
+    expiry?: string;
+    strike?: string;
+    right?: string;
+    assetQuoteType?: string;
+    lang?: string;
+}
+export interface AssetsRequest {
+    account?: string;
+    subAccounts?: string[];
+    segment?: boolean;
+    marketValue?: boolean;
+    lang?: string;
+}
+export interface ManagedAccountsRequest {
+    account?: string;
+    lang?: string;
+}
+export interface DerivativeContractsRequest {
+    account?: string;
+    symbols: string[];
+    secType: string;
+    expiry?: string;
+    lang?: string;
+}
+export interface AnalyticsAssetRequest {
+    account?: string;
+    segType?: string;
+    /** 格式 "YYYY-MM-DD" */
+    startDate?: string;
+    endDate?: string;
+    lang?: string;
+}
+export interface AggregateAssetsRequest {
+    account?: string;
+    baseCurrency?: string;
+    segType?: string;
+    lang?: string;
+}
+export interface EstimateTradableQuantityRequest {
+    account?: string;
+    symbol: string;
+    secType: string;
+    action: string;
+    orderType?: string;
+    limitPrice?: number;
+    market?: string;
+    currency?: string;
+    expiry?: string;
+    strike?: string;
+    right?: string;
+    lang?: string;
+}
+export interface ForexOrderRequest {
+    account?: string;
+    segType?: string;
+    sourceCurrency: string;
+    targetCurrency: string;
+    sourceAmount?: number;
+    targetAmount?: number;
+    orderType?: string;
+    lang?: string;
+}
+export interface SegmentFundRequest {
+    account?: string;
+    id?: string;
+    fromSegment?: string;
+    toSegment?: string;
+    currency?: string;
+    amount?: number;
+    limit?: number;
+    lang?: string;
+}
+export interface FundDetailsRequest {
+    account?: string;
+    segTypes?: string[];
+    fundType?: string;
+    currency?: string;
+    /** 毫秒时间戳 */
+    startDate?: number;
+    /** 毫秒时间戳 */
+    endDate?: number;
+    limit?: number;
+    pageToken?: string;
+    lang?: string;
+}
+export interface FundingHistoryRequest {
+    account?: string;
+    segType?: string;
+    currency?: string;
+    /** 毫秒时间戳 */
+    startDate?: number;
+    /** 毫秒时间戳 */
+    endDate?: number;
+    limit?: number;
+    lang?: string;
+}
+export interface PositionTransferRequest {
+    fromAccount?: string;
+    toAccount: string;
+    market?: string;
+    transfers: Array<{
+        symbol?: string;
+        quantity?: number;
+        expiry?: string;
+        strike?: string;
+        right?: string;
+        secType?: string;
+    }>;
+    lang?: string;
+}
+export interface PositionTransferRecordsRequest {
+    /** wire: account_id */
+    accountId?: string;
+    sinceDate?: string;
+    toDate?: string;
+    market?: string;
+    limit?: number;
+    lang?: string;
+}
+export interface PositionTransferDetailRequest {
+    accountId?: string;
+    id: string;
+    lang?: string;
+}
+export interface PositionTransferExternalRecordsRequest {
+    accountId?: string;
+    sinceDate?: string;
+    toDate?: string;
+    market?: string;
+    limit?: number;
+    lang?: string;
+}
+/** 行权检验请求 (wire: option_exercise_check) */
+export interface OptionExerciseCheckRequest {
+    account?: string;
+    secretKey?: string;
+    /** 期权合约 ID */
+    contractId: number;
+    /** Exercise | Expire */
+    type: string;
+    quantity?: number;
+    /** yyyy-MM-dd，Exercise 类型建议填 */
+    executingDate?: string;
+    /** Exercise 类型建议填 */
+    isForce?: boolean;
+    /** 0–10，Expire 类型专用 */
+    itmRate?: number;
+    lang?: string;
+}
+/** 查询可行权持仓请求 (wire: option_exercise_position) */
+export interface OptionExercisePositionRequest {
+    account?: string;
+    secretKey?: string;
+    /** Exercise | Expire */
+    type: string;
+    lang?: string;
+}
+/** 提交行权申请请求 (wire: option_exercise_submit) */
+export interface OptionExerciseSubmitRequest {
+    account?: string;
+    secretKey?: string;
+    contractId: number;
+    /** Exercise | Expire */
+    type: string;
+    quantity: number;
+    /** Exercise 必填，yyyy-MM-dd */
+    executingDate?: string;
+    /** Exercise 必填 */
+    isForce?: boolean;
+    /** 0–10，Expire 专用 */
+    itmRate?: number;
+    lang?: string;
+}
+/** 分页查询行权记录请求 (wire: option_exercise_record) */
+export interface OptionExerciseRecordsRequest {
+    account?: string;
+    secretKey?: string;
+    /** 从 1 开始，默认 1 */
+    page?: number;
+    /** 1–100，默认 20 */
+    size?: number;
+    /** New | Cancel | Success | Fail */
+    status?: string;
+    /** Exercise | Expire */
+    type?: string;
+    symbol?: string;
+    /** symbol | expire_date | strike | is_call */
+    orderBy?: string;
+    lang?: string;
+}
+/** 撤销行权申请请求 (wire: option_exercise_cancel) */
+export interface OptionExerciseCancelRequest {
+    account?: string;
+    secretKey?: string;
+    id: number;
+    lang?: string;
+}