v1.4.13 feat(): added new endpoints, updated request/response types

Author: JJ-Cro

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "okx-api",
-  "version": "1.4.12",
+  "version": "1.4.13",
   "description": "Complete & robust Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package.json

@@ -252,6 +252,17 @@ import {
   Announcement,
 } from './types';
 import { ASSET_BILL_TYPE } from './constants';
+import {
+  AccruedInterestItem,
+  AccruedInterestRequest,
+  AdjustCollateralRequest,
+  CollateralAssetsResponse,
+  LoanHistoryItem,
+  LoanHistoryRequest,
+  LoanInfo,
+  MaxLoanRequest,
+  MaxLoanResponse,
+} from './types/rest/response/private-flexible-loan';
 
 export class RestClient extends BaseRestClient {
   /**
@@ -498,12 +509,14 @@ export class RestClient extends BaseRestClient {
   getMaxLoan(
     instId: string,
     mgnMode: MarginMode,
-    mgnCcy?: string
+    mgnCcy?: string,
+    ccy?: string
   ): Promise<AccountMaxLoan[]> {
     return this.getPrivate('/api/v5/account/max-loan', {
       instId,
       mgnMode,
       mgnCcy,
+      ccy,
     });
   }
 
@@ -814,6 +827,26 @@ export class RestClient extends BaseRestClient {
     return this.postPrivate('/api/v5/account/set-auto-loan', params);
   }
 
+  presetAccountLevelSwitch(params: {
+    acctLv: '2' | '3' | '4';
+    lever?: string;
+    riskOffsetType?: '1' | '2' | '3' | '4';
+  }): Promise<any[]> {
+    return this.postPrivate(
+      '/api/v5/account/account-level-switch-preset',
+      params
+    );
+  }
+
+  getAccountSwitchPrecheck(params: {
+    acctLv: '1' | '2' | '3' | '4';
+  }): Promise<any[]> {
+    return this.getPrivate(
+      '/api/v5/account/set-account-switch-precheck',
+      params
+    );
+  }
+
   setAccountMode(params: {
     acctLv: AccountLevel;
   }): Promise<AccountModeResult[]> {
@@ -2869,7 +2902,10 @@ export class RestClient extends BaseRestClient {
   }
 
   amendLendingOrder(params: LendingOrder): Promise<any[]> {
-    return this.postPrivate('/api/v5/finance/fixed-loan/lending-order', params);
+    return this.postPrivate(
+      '/api/v5/finance/fixed-loan/amend-lending-order',
+      params
+    );
   }
 
   getLendingOrders(params: GetLendingOrderListRequest): Promise<any[]> {
@@ -2886,6 +2922,56 @@ export class RestClient extends BaseRestClient {
     );
   }
 
+  /**
+   *
+   * Financial product - Flexible loan endpoints
+   *
+   */
+
+  getBorrowableCurrencies(): Promise<
+    {
+      borrowCcy: string;
+    }[]
+  > {
+    return this.get('/api/v5/finance/flexible-loan/borrow-currencies');
+  }
+
+  getCollateralAssets(params?: {
+    ccy?: string;
+  }): Promise<CollateralAssetsResponse[]> {
+    return this.get('/api/v5/finance/flexible-loan/collateral-assets', params);
+  }
+
+  getMaxLoanAmount(params: MaxLoanRequest): Promise<MaxLoanResponse[]> {
+    return this.postPrivate('/api/v5/finance/flexible-loan/max-loan', params);
+  }
+
+  adjustCollateral(params: AdjustCollateralRequest): Promise<[]> {
+    return this.postPrivate(
+      '/api/v5/finance/flexible-loan/adjust-collateral',
+      params
+    );
+  }
+
+  getLoanInfo(): Promise<LoanInfo[]> {
+    return this.getPrivate('/api/v5/finance/flexible-loan/loan-info');
+  }
+  getLoanHistory(params?: LoanHistoryRequest): Promise<LoanHistoryItem[]> {
+    return this.getPrivate(
+      '/api/v5/finance/flexible-loan/loan-history',
+      params
+    );
+  }
+
+  getAccruedInterest(
+    params?: AccruedInterestRequest
+  ): Promise<AccruedInterestItem[]> {
+    return this.getPrivate(
+      '/api/v5/finance/flexible-loan/interest-accrued',
+      params
+    );
+  }
+
   /**
    *
    * Affiliate endpoints

src/rest-client.ts

@@ -11,7 +11,7 @@ export interface GetLendingOrderListRequest {
 export interface LendingOrder {
   ccy: string;
   amt: string;
-  rate: string;
+  rate?: string;
   term: '30D';
   autoRenewal?: boolean;
 }

src/types/rest/request/simple-earn.ts

@@ -45,29 +45,32 @@ export interface AlgoOrderRequest {
   tag?: string;
   reduceOnly?: boolean;
   tgtCcy?: string;
-
   tpTriggerPx?: numberInString;
   tpTriggerPxType?: PriceTriggerType;
   tpOrdPx?: numberInString;
-
+  tpOrdKind?: string;
   slTriggerPx?: numberInString;
   slTriggerPxType?: PriceTriggerType;
   slOrdPx?: numberInString;
-
+  cxlOnClosePos?: boolean;
   triggerPx?: numberInString;
   triggerPxType?: PriceTriggerType;
   orderPx?: numberInString;
-
+  chaseType?: string;
+  chaseVal?: numberInString;
+  maxChaseType?: string;
+  maxChaseVal?: numberInString;
   callbackRatio?: numberInString;
   callbackSpread?: numberInString;
   activePx?: numberInString;
-
   pxVar?: numberInString;
   pxSpread?: numberInString;
   szLimit?: numberInString;
   pxLimit?: numberInString;
-
   timeInterval?: string;
+  quickMgnType?: string;
+  closeFraction?: numberInString;
+  attachAlgoOrds?: AlgoTriggerOrder[];
 }
 
 export interface AmendOrderRequest {

src/types/rest/request/trade.ts

@@ -8,3 +8,4 @@ export * from './private-signal-bot';
 export * from './private-recurring-buy';
 export * from './private-copy-trading';
 export * from './private-spread-trading';
+export * from './private-flexible-loan';

src/types/rest/response/index.ts

@@ -0,0 +1,92 @@
+export interface CollateralAsset {
+  ccy: string;
+  amt: string;
+  notionalUsd: string;
+}
+
+export interface CollateralAssetsResponse {
+  assets: CollateralAsset[];
+}
+
+export interface SupplementaryCollateral {
+  ccy: string;
+  amt: string;
+}
+
+export interface MaxLoanRequest {
+  borrowCcy: string;
+  supCollateral?: SupplementaryCollateral[];
+}
+
+export interface MaxLoanResponse {
+  borrowCcy: string;
+  maxLoan: string;
+  notionalUsd: string;
+  remainingQuota: string;
+}
+
+export interface AdjustCollateralRequest {
+  type: 'add' | 'reduce';
+  collateralCcy: string;
+  collateralAmt: string;
+}
+
+export interface LoanCurrencyData {
+  ccy: string;
+  amt: string;
+}
+
+export interface RiskWarningData {
+  instId: string;
+  liqPx: string;
+}
+
+export interface LoanInfo {
+  loanNotionalUsd: string;
+  loanData: LoanCurrencyData[];
+  collateralNotionalUsd: string;
+  collateralData: LoanCurrencyData[];
+  riskWarningData: RiskWarningData;
+  curLTV: string;
+  marginCallLTV: string;
+  liqLTV: string;
+}
+
+export interface LoanHistoryRequest {
+  type?:
+    | 'borrowed'
+    | 'repaid'
+    | 'collateral_locked'
+    | 'collateral_released'
+    | 'forced_repayment_buy'
+    | 'forced_repayment_sell'
+    | 'forced_liquidation'
+    | 'partial_liquidation';
+  after?: string;
+  before?: string;
+  limit?: string;
+}
+
+export interface LoanHistoryItem {
+  refId: string;
+  type: string;
+  ccy: string;
+  amt: string;
+  ts: string;
+}
+
+export interface AccruedInterestRequest {
+  ccy?: string;
+  after?: string;
+  before?: string;
+  limit?: string;
+}
+
+export interface AccruedInterestItem {
+  refId: string;
+  ccy: string;
+  loan: string;
+  interest: string;
+  interestRate: string;
+  ts: string;
+}

src/types/rest/response/private-flexible-loan.ts

@@ -1,25 +1,36 @@
 import { ASSET_BILL_TYPE } from '../../../constants';
 
 export interface FundingCurrency {
-  canDep: boolean;
-  canInternal: boolean;
-  canWd: boolean;
-  ccy: string;
-  chain: string;
-  logoLink: string;
-  mainNet: boolean;
-  fee: string;
-  maxWd: string;
-  minDep: string;
-  minDepArrivalConfirm: string;
-  minWd: string;
-  minWdUnlockConfirm: string;
-  name: string;
-  needTag: boolean;
-  usedWdQuota: string;
-  wdQuota: string;
-  wdTickSz: string;
-  burningFeeRate: string;
+  ccy: string; // Currency code (e.g., "BTC")
+  name: string; // Currency name
+  logoLink: string; // Currency logo URL
+  chain: string; // Chain name (e.g., "BTC-Bitcoin")
+  ctAddr: string; // Contract address
+  canDep: boolean; // Deposit availability
+  canWd: boolean; // Withdrawal availability
+  canInternal: boolean; // Internal transfer availability
+  depEstOpenTime: string; // Estimated deposit opening time (timestamp)
+  wdEstOpenTime: string; // Estimated withdrawal opening time (timestamp)
+  minDep: string; // Minimum deposit amount
+  minWd: string; // Minimum withdrawal amount
+  minInternal: string; // Minimum internal transfer amount
+  maxWd: string; // Maximum withdrawal amount per transaction
+  wdTickSz: string; // Withdrawal precision (decimal places)
+  wdQuota: string; // 24h withdrawal limit in USD
+  usedWdQuota: string; // Used withdrawal quota in USD
+  fee: string; // Fixed withdrawal fee
+  minFee: string; // Minimum withdrawal fee (deprecated)
+  maxFee: string; // Maximum withdrawal fee (deprecated)
+  minFeeForCtAddr: string; // Minimum contract address withdrawal fee (deprecated)
+  maxFeeForCtAddr: string; // Maximum contract address withdrawal fee (deprecated)
+  burningFeeRate: string; // Burning fee rate (e.g., "0.05" for 5%)
+  mainNet: boolean; // Is main network
+  needTag: boolean; // Requires tag/memo for withdrawal
+  minDepArrivalConfirm: string; // Min confirmations for deposit credit
+  minWdUnlockConfirm: string; // Min confirmations for withdrawal unlock
+  depQuotaFixed: string; // Fixed deposit limit in USD
+  usedDepQuotaFixed: string; // Used fixed deposit quota in USD
+  depQuoteDailyLayer2: string; // Layer2 daily deposit limit
 }
 
 export interface FundingBalance {