okx-api 3.1.3 → 3.1.5

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;
@@ -360,7 +386,7 @@ export interface AccountInstrument {
     quoteCcy: string;
     tradeQuoteCcyList: string[];
     settleCcy: string;
-    /** Instrument status: live, suspend, rebase (SWAP only), preopen, test */
+    /** Instrument status: live, suspend, rebase (SWAP only), post_only (SWAP only), preopen, test */
     state: string;
     stk: string;
     tickSz: 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-affiliate.d.ts

@@ -0,0 +1,106 @@
+import type { AffiliateCommissionCategory } from '../request/affiliate.js';
+export interface AffiliatePerformanceSummaryDetail {
+    commissionCategory: AffiliateCommissionCategory;
+    firstTraderCnt: string;
+    traderCnt: string;
+    vol: string;
+    commission: string;
+}
+export interface AffiliatePerformanceSummary {
+    uTime: string;
+    inviteeCnt: string;
+    depAmt: string;
+    details: AffiliatePerformanceSummaryDetail[];
+}
+export interface InviteeDetail {
+    inviteeLevel: string;
+    joinTime: string;
+    inviteeRebateRate: string;
+    totalCommission: string;
+    firstTradeTime: string;
+    level: string;
+    depAmt: string;
+    wdAmt: string;
+    volMonth: string;
+    totalVol: string;
+    accFee: string;
+    kycTime: string;
+    region: string;
+    affiliateCode: string;
+}
+export type AffiliateInviteeListKycStatus = 'unverified' | 'verified';
+export interface AffiliateInviteeListItem {
+    uid: string;
+    country: string;
+    joinTime: string;
+    firstTradeTime: string;
+    channelName: string;
+    rebateRate: string;
+    feeTierRank: string;
+    kycStatus: AffiliateInviteeListKycStatus;
+    kycTime: string;
+    depAmt: string;
+    totalVol: string;
+    totalFee: string;
+    totalCommission: string;
+    isCompliant: boolean;
+}
+export type AffiliateLinkListLinkType = 'standard' | 'co_inviter';
+export type AffiliateLinkListLinkStatus = 'normal' | 'abnormal';
+export interface AffiliateLinkListItem {
+    channelId: string;
+    channelName: string;
+    joinLink: string;
+    linkType: AffiliateLinkListLinkType;
+    inviterCommissionRate: string;
+    coInviterCommissionRate: string;
+    inviteeDiscountRate: string;
+    inviteeCnt: string;
+    traderCnt: string;
+    totalCommission: string;
+    commission24h: string;
+    cTime: string;
+    isDefault: boolean;
+    linkStatus: AffiliateLinkListLinkStatus;
+}
+export type AffiliateChannelAssessmentStatus = 'valid' | 'not_reach_trade' | 'not_reach_invite' | 'not_reach_both';
+export type AffiliateInviterChannelStatus = 'valid' | 'identity_invalid' | 'level_downgraded';
+export type AffiliateCoInviterChannelStatus = 'valid' | 'identity_invalid' | 'not_reach_assessment' | 'identity_invalid_and_not_reach_assessment';
+export interface AffiliateCoInviterLinkListItem {
+    channelId: string;
+    channelName: string;
+    joinLink: string;
+    inviterCommissionRate: string;
+    coInviterCommissionRate: string;
+    inviteeDiscountRate: string;
+    parUserName: string;
+    coUserName: string;
+    isCompliant: boolean;
+    note?: string;
+    isDefault: boolean;
+    totalCommission: string;
+    commission24h: string;
+    inviteeCnt: string;
+    traderCnt: string;
+    clickCnt: string;
+    totalFee: string;
+    cTime: string;
+    channelAssessmentStatus: AffiliateChannelAssessmentStatus;
+    inviterChannelStatus: AffiliateInviterChannelStatus;
+    coInviterChannelStatus: AffiliateCoInviterChannelStatus;
+    linkStatus: AffiliateLinkListLinkStatus;
+}
+export interface AffiliateSubAffiliateListItem {
+    subAffiliateUid: string;
+    country: string;
+    joinTime: string;
+    subAffiliateLevel: string;
+    commissionRate: string;
+    isCompliant: boolean;
+    inviteeCnt: string;
+    traderCnt: string;
+    depAmt: string;
+    totalVol: string;
+    totalFee: string;
+    totalCommission: string;
+}

package/dist/cjs/types/rest/response/private-affiliate.js

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

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

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

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-stable-rewards.d.ts

@@ -0,0 +1,57 @@
+export interface StableRewardsProductInfoDetail {
+    ccy: string;
+    settleCcy: string;
+    subFeeRate: string;
+    redemptFeeRate: string;
+    minSubAmt: string;
+    minRedeemAmt: string;
+    remainingSubQuota: string;
+    remainingRedemptQuota: string;
+    canRedeem: boolean;
+}
+export interface StableRewardsProductInfo {
+    details: StableRewardsProductInfoDetail[];
+    ts: string;
+}
+export interface StableRewardsQuote {
+    quoteId: string;
+    quoteAmt: string;
+    quoteCcy: string;
+    exchRate: string;
+    feeRate: string;
+    quoteTime: string;
+    ttlMs: string;
+}
+export interface StableRewardsTradeResult {
+    quoteId: string;
+    ordId: string;
+}
+export type StableRewardsBalanceState = 'earning' | 'pending';
+export interface StableRewardsBalanceDetail {
+    ccy: string;
+    amt: string;
+    totalEarnAccrual: string;
+    state: StableRewardsBalanceState;
+}
+export interface StableRewardsBalance {
+    details: StableRewardsBalanceDetail[];
+    ts: string;
+}
+export interface StableRewardsApyHistoryItem {
+    rate: string;
+    ts: string;
+}
+export type StableRewardsSubscribeRedeemType = 'subscribe' | 'redeem';
+export type StableRewardsSubscribeRedeemStatus = 'pending' | 'success' | 'failed';
+export interface StableRewardsSubscribeRedeemHistoryItem {
+    type: StableRewardsSubscribeRedeemType;
+    status: StableRewardsSubscribeRedeemStatus;
+    ccy: string;
+    settleCcy: string;
+    ccyAmt: string;
+    settleCcyAmt: string;
+    fee: string;
+    quoteId: string;
+    ordId: string;
+    ts: string;
+}

package/dist/cjs/types/rest/response/private-stable-rewards.js

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

package/dist/cjs/types/rest/response/private-stable-rewards.js.map

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

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;