@tigeropenapi/tigeropen 0.1.0 → 0.4.0

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

@@ -44,18 +44,28 @@ export declare enum OrderType {
     VWAP = "VWAP",
     OCA = "OCA"
 }
-/** 订单状态枚举 */
+/**
+ * 订单状态枚举。对齐 Java SDK OrderStatus 定义。
+ *
+ * 服务端 wire 返回的值同时可能是:
+ * - 数字: -2 / -1 / 3 / 4 / 5 / 6 / 7 / 8
+ * - 字符串: "Invalid" / "Initial" / "PendingCancel" / "Cancelled" /
+ *           "Submitted" / "Filled" / "Inactive" / "PendingSubmit"
+ *
+ * Client 层通过 normalizeOrderStatus() 做数字→字符串归一,不做跨别名合并。
+ */
 export declare enum OrderStatus {
-    PendingNew = "PendingNew",
+    Invalid = "Invalid",
     Initial = "Initial",
+    PendingCancel = "PendingCancel",
+    Cancelled = "Cancelled",
     Submitted = "Submitted",
-    PartiallyFilled = "PartiallyFilled",
     Filled = "Filled",
-    Cancelled = "Cancelled",
-    PendingCancel = "PendingCancel",
     Inactive = "Inactive",
-    Invalid = "Invalid"
+    PendingSubmit = "PendingSubmit"
 }
+/** 返回订单状态对应的服务端数字码,未知返回 0。 */
+export declare function orderStatusCode(status: OrderStatus | string): number;
 /** K 线周期枚举 */
 export declare enum BarPeriod {
     Day = "day",
@@ -95,3 +105,47 @@ export declare enum TimeInForce {
     GTC = "GTC",
     OPG = "OPG"
 }
+/** 订单排序字段 */
+export declare enum OrderSortBy {
+    LatestCreated = "LATEST_CREATED",
+    LatestStatusUpdated = "LATEST_STATUS_UPDATED"
+}
+/** 账户分部类型 */
+export declare enum SegmentType {
+    All = "ALL",
+    Sec = "SEC",
+    Fut = "FUT",
+    Fund = "FUND"
+}
+/** 公司行动类型 */
+export declare enum CorporateActionType {
+    Split = "split",
+    Dividend = "dividend",
+    Earning = "earning"
+}
+/** 行业级别 (1~4 级) */
+export declare enum IndustryLevel {
+    GSector = "GSECTOR",
+    GGroup = "GGROUP",
+    GInd = "GIND",
+    GSubInd = "GSUBIND"
+}
+/** 排序方向 */
+export declare enum SortDirection {
+    No = "SortDir_No",
+    Ascend = "SortDir_Ascend",
+    Descend = "SortDir_Descend"
+}
+/** 期权分析周期 */
+export declare enum OptionAnalysisPeriod {
+    ThreeYear = "3year",
+    FiftyTwoWeek = "52week",
+    TwentySixWeek = "26week",
+    ThirteenWeek = "13week"
+}
+/** 财报类型 */
+export declare enum FinancialReportPeriod {
+    Annual = "Annual",
+    Quarterly = "Quarterly",
+    LTM = "LTM"
+}

package/dist/types/model/order-helpers.d.ts

@@ -1,22 +1,23 @@
 /**
- * 订单构造工具函数
+ * Order construction helpers.
+ * All helpers return an `OrderRequest` with sensible defaults.
  */
-import type { Order, OrderLeg, AlgoParams } from './order';
-/** 构造市价单 */
-export declare function marketOrder(account: string, symbol: string, secType: string, action: string, quantity: number): Order;
-/** 构造限价单 */
-export declare function limitOrder(account: string, symbol: string, secType: string, action: string, quantity: number, limitPrice: number): Order;
-/** 构造止损单 */
-export declare function stopOrder(account: string, symbol: string, secType: string, action: string, quantity: number, auxPrice: number): Order;
-/** 构造止损限价单 */
-export declare function stopLimitOrder(account: string, symbol: string, secType: string, action: string, quantity: number, limitPrice: number, auxPrice: number): Order;
-/** 构造跟踪止损单 */
-export declare function trailOrder(account: string, symbol: string, secType: string, action: string, quantity: number, trailingPercent: number): Order;
-/** 构造竞价限价单 */
-export declare function auctionLimitOrder(account: string, symbol: string, secType: string, action: string, quantity: number, limitPrice: number): Order;
-/** 构造竞价市价单 */
-export declare function auctionMarketOrder(account: string, symbol: string, secType: string, action: string, quantity: number): Order;
-/** 构造算法订单（TWAP/VWAP） */
-export declare function algoOrder(account: string, symbol: string, secType: string, action: string, quantity: number, limitPrice: number, algoType: string, params: AlgoParams): Order;
-/** 构造附加订单（止盈/止损） */
-export declare function orderLeg(legType: string, price: number, timeInForce: string): OrderLeg;
+import type { OrderRequest, OrderLegRequest, AlgoParamsRequest } from './order';
+/** Market order */
+export declare function marketOrder(account: string, symbol: string, secType: string, action: string, quantity: number): OrderRequest;
+/** Limit order */
+export declare function limitOrder(account: string, symbol: string, secType: string, action: string, quantity: number, limitPrice: number): OrderRequest;
+/** Stop order */
+export declare function stopOrder(account: string, symbol: string, secType: string, action: string, quantity: number, auxPrice: number): OrderRequest;
+/** Stop limit order */
+export declare function stopLimitOrder(account: string, symbol: string, secType: string, action: string, quantity: number, limitPrice: number, auxPrice: number): OrderRequest;
+/** Trailing stop order */
+export declare function trailOrder(account: string, symbol: string, secType: string, action: string, quantity: number, trailingPercent: number): OrderRequest;
+/** Auction limit order */
+export declare function auctionLimitOrder(account: string, symbol: string, secType: string, action: string, quantity: number, limitPrice: number): OrderRequest;
+/** Auction market order */
+export declare function auctionMarketOrder(account: string, symbol: string, secType: string, action: string, quantity: number): OrderRequest;
+/** Algo order (TWAP / VWAP) */
+export declare function algoOrder(account: string, symbol: string, secType: string, action: string, quantity: number, limitPrice: number, algoType: string, params: AlgoParamsRequest): OrderRequest;
+/** Attached profit / loss leg */
+export declare function orderLeg(legType: string, price: number, timeInForce: string): OrderLegRequest;

package/dist/types/model/order-status.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Order status normalization.
+ *
+ * 服务端返回的订单状态有时是整数(-2/-1/3/4/5/6/7/8),有时是字符串
+ * ("Invalid"/"Submitted"/...)。本模块把二者统一为 Java SDK OrderStatus 的
+ * 字符串值。不做跨别名合并。
+ *
+ * 对齐 Java SDK OrderStatus.java。
+ */
+/**
+ * 把服务端可能返回的 string/number 订单状态归一为字符串。
+ * 字符串原样透传;数字按映射表转换;其他输入返回空串。
+ */
+export declare function normalizeOrderStatus(raw: unknown): string;

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

@@ -1,95 +1,141 @@
 /**
- * Order 订单接口
- * 字段名 camelCase 与 API JSON 天然一致，不改名、不加封装层
+ * Order response / request models.
+ *
+ * TypeScript uses camelCase field names idiomatically. The client layer
+ * transparently converts request camelCase to snake_case before sending;
+ * server responses are already camelCase so they decode directly.
  */
-/** 附加订单（止盈/止损） */
+/** Attached leg order (profit / loss) — response side */
 export interface OrderLeg {
-    /** 附加订单类型（PROFIT/LOSS） */
     legType?: string;
-    /** 价格 */
     price?: number;
-    /** 有效期 */
     timeInForce?: string;
-    /** 数量 */
     quantity?: number;
 }
-/** 算法订单参数 */
+/** Algo order parameters — response side */
 export interface AlgoParams {
-    /** 算法策略（TWAP/VWAP） */
     algoStrategy?: string;
-    /** 开始时间 */
     startTime?: string;
-    /** 结束时间 */
     endTime?: string;
-    /** 参与率 */
     participationRate?: number;
 }
-/** 订单模型，字段名词根保持与 API JSON 一致 */
+/** Order response model (returned by order query methods). */
 export interface Order {
-    /** 交易账户 */
-    account: string;
-    /** 全局订单 ID */
+    account?: string;
     id?: number;
-    /** 账户自增订单号 */
     orderId?: number;
-    /** 买卖方向（BUY/SELL） */
-    action: string;
-    /** 订单类型（MKT/LMT/STP/STP_LMT/TRAIL 等） */
-    orderType: string;
-    /** 总数量（API 返回字段名为 totalQuantity） */
-    totalQuantity: number;
-    /** 限价 */
+    externalId?: string;
+    action?: string;
+    orderType?: string;
+    totalQuantity?: number;
+    totalQuantityScale?: number;
+    filledQuantity?: number;
+    filledQuantityScale?: number;
+    filledCashAmount?: number;
     limitPrice?: number;
-    /** 辅助价格（止损价） */
     auxPrice?: number;
-    /** 跟踪止损百分比 */
     trailingPercent?: number;
-    /** 订单状态 */
     status?: string;
-    /** 已成交数量（API 返回字段名为 filledQuantity） */
-    filledQuantity?: number;
-    /** 平均成交价 */
     avgFillPrice?: number;
-    /** 有效期（DAY/GTC/OPG） */
-    timeInForce: string;
-    /** 是否允许盘前盘后 */
-    outsideRth: boolean;
-    /** 附加订单（止盈/止损） */
+    timeInForce?: string;
+    outsideRth?: boolean;
     orderLegs?: OrderLeg[];
-    /** 算法参数 */
     algoParams?: AlgoParams;
-    /** 股票代码 */
-    symbol: string;
-    /** 合约类型 */
-    secType: string;
-    /** 市场 */
+    algoStrategy?: string;
+    symbol?: string;
+    secType?: string;
     market?: string;
-    /** 货币 */
     currency?: string;
-    /** 到期日（期权/期货） */
     expiry?: string;
-    /** 行权价（期权），API 返回为字符串 */
     strike?: string;
-    /** 看涨/看跌（PUT/CALL），保持 API 原始名 right */
     right?: string;
-    /** 合约标识符 */
     identifier?: string;
-    /** 合约名称 */
     name?: string;
-    /** 佣金 */
     commission?: number;
-    /** 已实现盈亏 */
+    gst?: number;
     realizedPnl?: number;
-    /** 开仓时间（毫秒时间戳） */
     openTime?: number;
-    /** 更新时间（毫秒时间戳） */
     updateTime?: number;
-    /** 最新时间（毫秒时间戳） */
     latestTime?: number;
-    /** 备注 */
+    latestPrice?: number;
     remark?: string;
-    /** 订单来源 */
     source?: string;
-    /** 用户标记 */
     userMark?: string;
+    liquidation?: boolean;
+    discount?: number;
+    replaceStatus?: string;
+    cancelStatus?: string;
+    canModify?: boolean;
+    canCancel?: boolean;
+    isOpen?: boolean;
+    orderDiscount?: number;
+    tradingSessionType?: string;
+    attrDesc?: string;
+    attrList?: string[];
+}
+/**
+ * OrderRequest — order request model used by placeOrder / previewOrder / modifyOrder.
+ * Fields are camelCase in TypeScript; the client converts them to snake_case on the wire.
+ */
+export interface OrderRequest {
+    /** Account ID (client fills it in automatically) */
+    account?: string;
+    /** Global order ID (required for modify) */
+    id?: number;
+    /** Account-level order ID */
+    orderId?: number;
+    /** BUY / SELL */
+    action: string;
+    /** Order type: MKT / LMT / STP / STP_LMT / TRAIL / AM / AL / TWAP / VWAP / OCA */
+    orderType: string;
+    /** Total quantity */
+    totalQuantity: number;
+    /** Limit price (required for LMT / STP_LMT) */
+    limitPrice?: number;
+    /** Stop / trigger price (required for STP / STP_LMT / TRAIL) */
+    auxPrice?: number;
+    /** Trailing stop percent */
+    trailingPercent?: number;
+    /** DAY / GTC / GTD / OPG */
+    timeInForce: string;
+    /** Allow extended-hours trading */
+    outsideRth?: boolean;
+    /** Attached legs (profit / loss) */
+    orderLegs?: OrderLegRequest[];
+    /** Algo parameters */
+    algoParams?: AlgoParamsRequest;
+    /** Contract symbol */
+    symbol: string;
+    /** STK / OPT / FUT / WAR / IOPT */
+    secType: string;
+    /** Market */
+    market?: string;
+    /** Currency */
+    currency?: string;
+    /** Option expiry */
+    expiry?: string;
+    /** Option strike */
+    strike?: string;
+    /** CALL / PUT */
+    right?: string;
+    /** Contract identifier */
+    identifier?: string;
+    /** Remark */
+    remark?: string;
+    /** User mark */
+    userMark?: string;
+}
+/** Attached leg for request side */
+export interface OrderLegRequest {
+    legType: string;
+    price?: number;
+    timeInForce?: string;
+    quantity?: number;
+}
+/** Algo parameters for request side */
+export interface AlgoParamsRequest {
+    algoStrategy?: string;
+    startTime?: string;
+    endTime?: string;
+    participationRate?: number;
 }

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

@@ -1,39 +1,41 @@
 /**
- * Position 持仓接口
- * 字段名 camelCase 与 API JSON 天然一致，不改名、不加封装层
+ * Position model.
  */
-/** 持仓模型，字段名词根保持与 API JSON 一致 */
+/** Position (returned by positions query) */
 export interface Position {
-    /** 交易账户 */
-    account: string;
-    /** 标的代码 */
-    symbol: string;
-    /** 证券类型 */
-    secType: string;
-    /** 市场 */
+    account?: string;
+    symbol?: string;
+    secType?: string;
     market?: string;
-    /** 货币 */
     currency?: string;
-    /** 持仓数量（API 返回字段名为 position） */
-    position: number;
-    /** 平均成本 */
-    averageCost: number;
-    /** 市值 */
+    position?: number;
+    positionScale?: number;
+    positionQty?: number;
+    salableQty?: number;
+    averageCost?: number;
+    averageCostByAverage?: number;
+    averageCostOfCarry?: number;
     marketValue?: number;
-    /** 已实现盈亏 */
     realizedPnl?: number;
-    /** 未实现盈亏 */
+    realizedPnlByAverage?: number;
     unrealizedPnl?: number;
-    /** 未实现盈亏百分比 */
+    unrealizedPnlByAverage?: number;
+    unrealizedPnlByCostOfCarry?: number;
     unrealizedPnlPercent?: number;
-    /** 合约 ID */
+    unrealizedPnlPercentByAverage?: number;
+    unrealizedPnlPercentByCostOfCarry?: number;
     contractId?: number;
-    /** 合约标识符 */
     identifier?: string;
-    /** 合约名称 */
     name?: string;
-    /** 最新价格 */
     latestPrice?: number;
-    /** 合约乘数 */
+    lastClosePrice?: number;
     multiplier?: number;
+    status?: number;
+    updateTimestamp?: number;
+    mmPercent?: number;
+    mmValue?: number;
+    todayPnl?: number;
+    todayPnlPercent?: number;
+    comboTypes?: string[];
+    categories?: string[];
 }