okx-api 3.1.3 → 3.1.4

package/dist/cjs/types/rest/request/public.d.ts

@@ -53,3 +53,48 @@ export interface GetOptionTradesRequest {
     instFamily?: string;
     optType?: 'C' | 'P';
 }
+/**
+ * @see GET /api/v5/public/market-data-history
+ * Module 11: borrowing rate (T+2 typical, UTC+8 for timestamp parsing).
+ */
+export interface GetHistoricalMarketDataRequest {
+    /**
+     * 1: trades, 2: 1m candles, 3: funding rate, 4: 400-level book, 5: 5000-level, 6: 50-level (use 4/5), 11: borrowing rate
+     */
+    module: string;
+    instType: 'SPOT' | 'FUTURES' | 'SWAP' | 'OPTION';
+    instIdList?: string;
+    instFamilyList?: string;
+    dateAggrType: 'daily' | 'monthly';
+    begin: string;
+    end: string;
+}
+/**
+ * @see GET /api/v5/public/event-contract/series
+ */
+export interface GetEventContractSeriesRequest {
+    seriesId?: string;
+}
+/**
+ * @see GET /api/v5/public/event-contract/events
+ */
+export interface GetEventContractEventsRequest {
+    seriesId: string;
+    eventId?: string;
+    state?: 'preopen' | 'live' | 'settling' | 'expired' | string;
+    limit?: string;
+    before?: string;
+    after?: string;
+}
+/**
+ * @see GET /api/v5/public/event-contract/markets
+ */
+export interface GetEventContractMarketsRequest {
+    seriesId: string;
+    eventId?: string;
+    instId?: string;
+    state?: 'preopen' | 'live' | 'settling' | 'expired' | string;
+    limit?: string;
+    before?: string;
+    after?: string;
+}

package/dist/cjs/types/rest/request/trade.d.ts

@@ -18,6 +18,15 @@ export interface AlgoLongHistoryRequest {
     before?: string;
     limit?: string;
 }
+/**
+ * When amending an attached trailing stop via amend algo / attach block (2026-04-13).
+ * Only one of newCallbackRatio or newCallbackSpread.
+ */
+export interface AmendAttachedTrailingStop {
+    newCallbackRatio?: string;
+    newCallbackSpread?: string;
+    newActivePx?: string;
+}
 interface AlgoTriggerOrder {
     newTpTriggerPx?: string;
     newTpTriggerPxType?: 'last' | 'index' | 'mark';
@@ -25,6 +34,36 @@ interface AlgoTriggerOrder {
     newSlTriggerPx?: string;
     newSlTriggerPxType?: 'last' | 'index' | 'mark';
     newSlOrdPx?: string;
+    newCallbackRatio?: string;
+    newCallbackSpread?: string;
+    newActivePx?: string;
+}
+/**
+ * TP/SL and trailing (move_order_stop) attached to a parent `order` (2026-04-13: callbackRatio | callbackSpread, activePx).
+ */
+export interface AttachAlgoOrdRequest {
+    attachAlgoClOrdId?: string;
+    tpTriggerPx?: string;
+    /** Only one of tpTriggerPx and tpTriggerRatio (FUTURES/SWAP). */
+    tpTriggerRatio?: string;
+    tpOrdPx?: string;
+    tpOrdKind?: 'condition' | 'limit';
+    slTriggerPx?: string;
+    slTriggerRatio?: string;
+    slOrdPx?: string;
+    tpTriggerPxType?: 'last' | 'index' | 'mark';
+    slTriggerPxType?: 'last' | 'index' | 'mark';
+    sz?: string;
+    amendPxOnTriggerType?: '0' | '1';
+    /**
+     * Trailing stop: one of `callbackRatio` or `callbackSpread` when attached ordType is `move_order_stop`.
+     * e.g. 0.05 = 5%
+     */
+    callbackRatio?: string;
+    /** Trailing: price distance (alternative to callbackRatio). */
+    callbackSpread?: string;
+    /** Trailing: activation; omit = activate immediately. */
+    activePx?: string;
 }
 export interface AlgoOrderRequest {
     instId: string;
@@ -64,15 +103,7 @@ export interface AlgoOrderRequest {
     quickMgnType?: string;
     closeFraction?: numberInString;
     advanceOrdType?: 'fok' | 'ioc' | '';
-    attachAlgoOrds?: {
-        attachAlgoClOrdId?: string;
-        tpTriggerPx?: string;
-        tpOrdPx?: string;
-        slTriggerPx?: string;
-        slOrdPx?: string;
-        tpTriggerPxType?: string;
-        slTriggerPxType?: string;
-    }[];
+    attachAlgoOrds?: AttachAlgoOrdRequest[];
 }
 export interface AmendOrderRequest {
     instId: string;
@@ -82,6 +113,12 @@ export interface AmendOrderRequest {
     reqId?: string;
     newSz?: string;
     newPx?: string;
+    /** EVENTS: `"1"` for non-`post_only` amends when applicable. */
+    speedBump?: string;
+    /**
+     * Amend attached trailing stop (or related attach algo) — only one of newCallbackRatio / newCallbackSpread per item (2026-04-13).
+     */
+    attachAlgoOrds?: AmendAttachedTrailingStop[];
 }
 export type AlgoOrderDetailsRequest = {
     algoId: string;
@@ -132,9 +169,14 @@ export interface FillsHistoryRequest {
     limit?: string;
 }
 export interface OrderIdRequest {
-    /** Instrument ID. Deprecated March 2026 for WS; use instIdCode for lower latency. */
+    /**
+     * REST: use as in trade docs. WebSocket `cancel-order` / `batch-cancel-orders`: deprecated (2026-04-07) — if sent, ignored; use
+     * `ordId` or `clOrdId`. Optional `instIdCode` may still be used to map the instrument.
+     */
     instId?: string;
-    /** Instrument ID code. Takes precedence over instId if both provided. Use Get instruments to map. WS only. */
+    /**
+     * Where supported, may take precedence over `instId` if both are present. Get instruments to map.
+     */
     instIdCode?: number;
     ordId?: string;
     clOrdId?: string;
@@ -180,6 +222,12 @@ export interface OrderRequest {
     stpMode?: 'cancel_maker' | 'cancel_taker' | 'cancel_both';
     /** ELP taker access. true = can trade with ELP orders (speed bump applied). Default false. Only applicable to ioc orders */
     isElpTakerAccess?: boolean;
+    /**
+     * EVENTS: set to `"1"` for non-`post_only` orders. Error 54086 if missing when required.
+     */
+    speedBump?: string;
+    /** EVENTS: `yes` or `no`. */
+    outcome?: string;
     /** Take Profit & Stop Loss params */
     tpTriggerPx?: string;
     tpOrdPx?: string;
@@ -187,33 +235,8 @@ export interface OrderRequest {
     slOrdPx?: string;
     tpTriggerPxType?: PriceTriggerType;
     slTriggerPxType?: PriceTriggerType;
-    /** TP/SL information attached when placing order (supports split TPs and advanced TP/SL configurations) */
-    attachAlgoOrds?: {
-        /** Client-supplied Algo ID when placing order attaching TP/SL */
-        attachAlgoClOrdId?: string;
-        /** Take-profit trigger price */
-        tpTriggerPx?: string;
-        /** Take profit trigger ratio, 0.3 represents 30%. Only one of tpTriggerPx and tpTriggerRatio can be passed */
-        tpTriggerRatio?: string;
-        /** Take-profit order price. -1 means market price */
-        tpOrdPx?: string;
-        /** TP order kind: "condition" or "limit". Default is "condition" */
-        tpOrdKind?: 'condition' | 'limit';
-        /** Stop-loss trigger price */
-        slTriggerPx?: string;
-        /** Stop loss trigger ratio, 0.3 represents 30%. Only one of slTriggerPx and slTriggerRatio can be passed */
-        slTriggerRatio?: string;
-        /** Stop-loss order price. -1 means market price */
-        slOrdPx?: string;
-        /** Take-profit trigger price type: last, index, or mark. Default is last */
-        tpTriggerPxType?: 'last' | 'index' | 'mark';
-        /** Stop-loss trigger price type: last, index, or mark. Default is last */
-        slTriggerPxType?: 'last' | 'index' | 'mark';
-        /** Size. Only applicable to TP order of split TPs, and it is required for TP order of split TPs */
-        sz?: string;
-        /** Whether to enable Cost-price SL. "0" = disable (default), "1" = Enable. Only applicable to SL order of split TPs */
-        amendPxOnTriggerType?: '0' | '1';
-    }[];
+    /** TP/SL / trailing (attach) when placing the parent order */
+    attachAlgoOrds?: AttachAlgoOrdRequest[];
     /** Quick margin type */
     quickMgnType?: 'manual' | 'auto_borrow' | 'auto_repay';
 }
@@ -231,16 +254,8 @@ export interface OrderPrecheckRequest {
     px?: string;
     reduceOnly?: boolean;
     tgtCcy?: string;
-    attachAlgoOrds?: {
-        attachAlgoClOrdId?: string;
-        tpTriggerPx?: string;
-        tpOrdPx?: string;
-        tpOrdKind?: string;
-        slTriggerPx?: string;
-        slOrdPx?: string;
-        tpTriggerPxType?: string;
-        slTriggerPxType?: string;
-        sz?: string;
-    }[];
+    /** EVENTS: `yes` / `no`. */
+    outcome?: string;
+    attachAlgoOrds?: AttachAlgoOrdRequest[];
 }
 export {};

package/dist/cjs/types/rest/response/private-account.d.ts

@@ -1,4 +1,5 @@
 import { AccountLevel, MarginMode, PositionSide, WithdrawState } from '../shared.js';
+import type { InstrumentUpcomingParamChange } from './public-data.js';
 export interface AccountBalanceDetail {
     availBal: string;
     availEq: string;
@@ -164,9 +165,25 @@ export interface AccountBill {
     earnAmt?: string;
     earnApr?: string;
 }
+export interface BillSubTypeDetail {
+    subType: string;
+    subTypeDesc: string;
+}
+/**
+ * @see GET /api/v5/account/subtypes
+ */
+export interface AccountBillTypeDefinition {
+    type: string;
+    typeDesc: string;
+    subTypeDetails: BillSubTypeDetail[];
+}
+/**
+ * Apply (POST) may return { result, ts }; get link (GET) may return { fileHref, state, ts }.
+ */
 export interface AccountHistoryBill {
-    fileHref: string;
-    result: string;
+    fileHref?: string;
+    result?: string;
+    state?: 'finished' | 'ongoing' | 'failed' | string;
     ts: string;
 }
 export interface AccountConfiguration {
@@ -261,6 +278,7 @@ export interface AccountFeeRate {
     makerU: string;
     taker: string;
     takerU: string;
+    settle?: string;
     ts: string;
     ruleType: string;
     feeGroup?: FeeGroup[];
@@ -341,6 +359,14 @@ export interface AccountInstrument {
     instFamily: string;
     instId: string;
     instType: string;
+    seriesId?: string;
+    uly?: string;
+    /**
+     * FUTURES label (deprecated — prefer `expTime`; may include this_five_years, next_five_years, …).
+     */
+    alias?: string;
+    /** Deprecated; see `instCategory` on public `Instrument` where used. */
+    category?: string;
     lever: string;
     listTime: string;
     contTdSwTime: string;
@@ -369,7 +395,10 @@ export interface AccountInstrument {
     auctionEndTime: string;
     futureSettlement: boolean;
     instIdCode: number;
-    /** Category of instrument's base currency. "1" = Crypto, "3" = Stocks */
+    /**
+     * Asset category of the instrument's base asset (see public `Instrument.instCategory` for values).
+     * 1: Crypto, 3: Stocks, 4: Commodities, 5: Forex, 6: Bonds, "": not available
+     */
     instCategory?: string;
     posLmtAmt: string;
     posLmtPct: string;
@@ -381,6 +410,7 @@ export interface AccountInstrument {
     groupId?: string;
     /** ELP maker permission. "0" = not enabled, "1" = enabled but no permission, "2" = enabled with permission */
     elp?: string;
+    upcChg?: InstrumentUpcomingParamChange[];
 }
 export interface QuickMarginBorrowRepayResult {
     instId: string;

package/dist/cjs/types/rest/response/private-dual-investment.d.ts

@@ -0,0 +1,87 @@
+export interface DcdCurrencyPair {
+    baseCcy: string;
+    quoteCcy: string;
+    optType: 'C' | 'P';
+    uly: string;
+}
+export interface DcdProduct {
+    absYield: string;
+    annualizedYield: string;
+    baseCcy: string;
+    quoteCcy: string;
+    expTime: string;
+    interestAccrualTime: string;
+    listTime: string;
+    maxSize: string;
+    minSize: string;
+    notionalCcy: string;
+    optType: 'C' | 'P';
+    productId: string;
+    quoteTime: string;
+    redeemEndTime: string;
+    redeemStartTime: string;
+    stepSz: string;
+    tradeEndTime: string;
+    strike: string;
+    uly: string;
+}
+export interface DcdQuote {
+    absYield: string;
+    annualizedYield: string;
+    interestAccrualTime: string;
+    notionalSz: string;
+    notionalCcy: string;
+    productId: string;
+    quoteId: string;
+    validUntil: string;
+    idxPx: string;
+}
+export type DcdTradeOrderState = 'initial' | 'pending_book' | 'live' | 'rejected';
+export interface DcdTradeResult {
+    quoteId: string;
+    ordId: string;
+    state: DcdTradeOrderState;
+}
+export interface DcdRedeemQuote {
+    ordId: string;
+    quoteId: string;
+    redeemCcy: string;
+    redeemSz: string;
+    termRate: string;
+    validUntil: string;
+}
+export type DcdRedeemConfirmState = 'pending_redeem_booking' | 'pending_redeem' | 'redeeming' | 'redeemed';
+export interface DcdRedeemResult {
+    ordId: string;
+    state: DcdRedeemConfirmState;
+}
+export type DcdOrderStatusState = 'initial' | 'live' | 'pending_settle' | 'settled' | 'pending_redeem' | 'redeemed' | 'rejected';
+export interface DcdOrderStatus {
+    ordId: string;
+    state: DcdOrderStatusState;
+}
+export interface DcdOrderHistoryItem {
+    ordId: string;
+    quoteId: string;
+    state: DcdOrderStatusState;
+    productId: string;
+    baseCcy: string;
+    quoteCcy: string;
+    uly: string;
+    strike: string;
+    notionalSz: string;
+    notionalCcy: string;
+    absYield: string;
+    annualizedYield: string;
+    yieldSz: string;
+    yieldCcy: string;
+    settleSz: string;
+    settleCcy: string;
+    settlePx: string;
+    settleTime: string;
+    expTime: string;
+    redeemStartTime: string;
+    redeemEndTime: string;
+    cTime: string;
+    uTime: string;
+}

package/dist/cjs/types/rest/response/private-dual-investment.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=private-dual-investment.js.map

package/dist/cjs/types/rest/response/private-dual-investment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-dual-investment.js","sourceRoot":"","sources":["../../../../../src/types/rest/response/private-dual-investment.ts"],"names":[],"mappings":""}

package/dist/cjs/types/rest/response/private-flexible-loan.d.ts

@@ -10,9 +10,16 @@ export interface SupplementaryCollateral {
     ccy: string;
     amt: string;
 }
+export interface GetFlexibleLoanCollateralAssetsRequest {
+    ccy?: string;
+    /** When the account has multiple active flexible-loan positions. */
+    ordId?: string;
+}
 export interface MaxLoanRequest {
     borrowCcy: string;
     supCollateral?: SupplementaryCollateral[];
+    /** When multiple active loans exist. */
+    ordId?: string;
 }
 export interface MaxLoanResponse {
     borrowCcy: string;
@@ -24,6 +31,8 @@ export interface AdjustCollateralRequest {
     type: 'add' | 'reduce';
     collateralCcy: string;
     collateralAmt: string;
+    /** When multiple active loans exist. */
+    ordId?: string;
 }
 export interface LoanCurrencyData {
     ccy: string;
@@ -33,9 +42,18 @@ export interface RiskWarningData {
     instId: string;
     liqPx: string;
 }
+export interface GetLoanInfoRequest {
+    /** When the account has multiple active flexible loans . */
+    ordId?: string;
+}
 export interface LoanInfo {
+    /**
+     * Active loan / position id when the account can hold multiple loan orders.
+     */
+    ordId?: string;
     loanNotionalUsd: string;
     loanData: LoanCurrencyData[];
+    /** Adjusted collateral value in USD. */
     collateralNotionalUsd: string;
     collateralData: LoanCurrencyData[];
     riskWarningData: RiskWarningData;
@@ -45,6 +63,8 @@ export interface LoanInfo {
 }
 export interface LoanHistoryRequest {
     type?: 'borrowed' | 'repaid' | 'collateral_locked' | 'collateral_released' | 'forced_repayment_buy' | 'forced_repayment_sell' | 'forced_liquidation' | 'partial_liquidation';
+    /** When multiple active loans exist. */
+    ordId?: string;
     after?: string;
     before?: string;
     limit?: string;
@@ -58,6 +78,8 @@ export interface LoanHistoryItem {
 }
 export interface AccruedInterestRequest {
     ccy?: string;
+    /** When multiple active loans exist. */
+    ordId?: string;
     after?: string;
     before?: string;
     limit?: string;

package/dist/cjs/types/rest/response/private-trade.d.ts

@@ -1,4 +1,24 @@
 import { AlgoOrderState, AlgoOrderType, AlgoPositionSide, numberInString, OrderState, OrderType, PositionSide } from '../shared.js';
+/**
+ * Nested rows in `attachAlgoOrds` on orders / history (incl. trailing stop fields)
+ */
+export interface AttachAlgoOrderDetail {
+    attachAlgoClOrdId?: string;
+    tpTriggerPx?: string;
+    tpTriggerRatio?: string;
+    tpOrdPx?: string;
+    tpOrdKind?: string;
+    slTriggerPx?: string;
+    slTriggerRatio?: string;
+    slOrdPx?: string;
+    tpTriggerPxType?: string;
+    slTriggerPxType?: string;
+    sz?: string;
+    amendPxOnTriggerType?: string;
+    callbackRatio?: string;
+    callbackSpread?: string;
+    activePx?: string;
+}
 export interface OrderResult {
     clOrdId: string;
     ordId: string;
@@ -52,12 +72,14 @@ export interface OrderDetails {
     slTriggerPx: string;
     slTriggerPxType: string;
     slOrdPx: string;
+    attachAlgoOrds?: AttachAlgoOrderDetail[];
     feeCcy: string;
     fee: string;
     rebateCcy: string;
     rebate: string;
     tgtCcy: string;
     category: string;
+    outcome?: string;
     uTime: string;
     cTime: string;
 }
@@ -91,7 +113,6 @@ export interface OrderListItem {
     slOrdPx: string;
     slTriggerPx: string;
     slTriggerPxType: string;
-    attachAlgoOrds: any[];
     state: OrderState;
     stpId: string;
     stpMode: string;
@@ -109,6 +130,8 @@ export interface OrderListItem {
     algoClOrdId: string;
     algoId: string;
     uTime: string;
+    attachAlgoOrds?: AttachAlgoOrderDetail[];
+    outcome?: string;
 }
 export interface HistoricOrder {
     instType: string;
@@ -141,7 +164,7 @@ export interface HistoricOrder {
     slTriggerPx: string;
     slTriggerPxType: string;
     slOrdPx: string;
-    attachAlgoOrds: any[];
+    attachAlgoOrds?: AttachAlgoOrderDetail[];
     stpId: string;
     stpMode: string;
     feeCcy: string;
@@ -157,6 +180,7 @@ export interface HistoricOrder {
     cancelSourceReason: string;
     algoClOrdId: string;
     algoId: string;
+    outcome?: string;
     uTime: string;
     cTime: string;
 }
@@ -194,7 +218,7 @@ export interface AlgoOrderDetailsResult {
     ccy: string;
     clOrdId: string;
     algoId: string;
-    attachAlgoOrds: any[];
+    attachAlgoOrds?: AttachAlgoOrderDetail[];
     sz: string;
     closeFraction: string;
     ordType: AlgoOrderType;
@@ -246,7 +270,7 @@ export interface AlgoOrderListItem {
     actualSide: string;
     actualSz: string;
     algoId: string;
-    attachAlgoOrds: any[];
+    attachAlgoOrds?: AttachAlgoOrderDetail[];
     cTime: string;
     callbackRatio: string;
     callbackSpread: string;
@@ -257,7 +281,7 @@ export interface AlgoOrderListItem {
     lever: string;
     moveTriggerPx: string;
     ordId: string;
-    ordIdList: any[];
+    ordIdList: string[];
     ordPx: string;
     ordType: AlgoOrderType;
     posSide: AlgoPositionSide;
@@ -301,7 +325,7 @@ export interface HistoricAlgoOrder {
     actualSz: string;
     algoClOrdId: string;
     algoId: string;
-    attachAlgoOrds: any[];
+    attachAlgoOrds?: AttachAlgoOrderDetail[];
     cTime: string;
     callbackRatio: string;
     callbackSpread: string;