Merge pull request #67 from JJ-Cro/RelNotes9_9_24

v1.4.4 feat(): added new endpoints, updated types

docs/endpointFunctionList.md

@@ -55,6 +55,8 @@ This table includes all endpoints from the official Exchange API docs and corres
 | `getAccountPositionRisk()` | :closed_lock_with_key:  | GET | `/api/v5/account/account-position-risk` |
 | `getBills()` | :closed_lock_with_key:  | GET | `/api/v5/account/bills` |
 | `getBillsArchive()` | :closed_lock_with_key:  | GET | `/api/v5/account/bills-archive` |
+| `requestBillsHistoryDownloadLink()` | :closed_lock_with_key:  | POST | `/api/v5/account/bills-history-archive` |
+| `getRequestedBillsHistoryLink()` | :closed_lock_with_key:  | GET | `/api/v5/account/bills-history-archive` |
 | `getAccountConfiguration()` | :closed_lock_with_key:  | GET | `/api/v5/account/config` |
 | `setPositionMode()` | :closed_lock_with_key:  | POST | `/api/v5/account/set-position-mode` |
 | `setLeverage()` | :closed_lock_with_key:  | POST | `/api/v5/account/set-leverage` |
@@ -65,6 +67,7 @@ This table includes all endpoints from the official Exchange API docs and corres
 | `getLeverageEstimatedInfo()` | :closed_lock_with_key:  | GET | `/api/v5/account/adjust-leverage-info` |
 | `getMaxLoan()` | :closed_lock_with_key:  | GET | `/api/v5/account/max-loan` |
 | `getFeeRates()` | :closed_lock_with_key:  | GET | `/api/v5/account/trade-fee` |
+| `getFeeRatesV2()` | :closed_lock_with_key:  | GET | `/api/v5/account/trade-fee` |
 | `getInterestAccrued()` | :closed_lock_with_key:  | GET | `/api/v5/account/interest-accrued` |
 | `getInterestRate()` | :closed_lock_with_key:  | GET | `/api/v5/account/interest-rate` |
 | `setGreeksDisplayType()` | :closed_lock_with_key:  | POST | `/api/v5/account/set-greeks` |
@@ -122,6 +125,7 @@ This table includes all endpoints from the official Exchange API docs and corres
 | `cancelMassOrder()` | :closed_lock_with_key:  | POST | `/api/v5/trade/mass-cancel` |
 | `cancelAllAfter()` | :closed_lock_with_key:  | POST | `/api/v5/trade/cancel-all-after` |
 | `getAccountRateLimit()` | :closed_lock_with_key:  | GET | `/api/v5/trade/account-rate-limit` |
+| `submitOrderPrecheck()` | :closed_lock_with_key:  | POST | `/api/v5/trade/order-precheck` |
 | `placeAlgoOrder()` | :closed_lock_with_key:  | POST | `/api/v5/trade/order-algo` |
 | `cancelAlgoOrder()` | :closed_lock_with_key:  | POST | `/api/v5/trade/cancel-algos` |
 | `amendAlgoOrder()` | :closed_lock_with_key:  | POST | `/api/v5/trade/amend-algos` |
@@ -147,6 +151,7 @@ This table includes all endpoints from the official Exchange API docs and corres
 | `getGridAIParameter()` |  | GET | `/api/v5/tradingBot/grid/ai-param` |
 | `computeGridMinInvestment()` |  | POST | `/api/v5/tradingBot/grid/min-investment` |
 | `getRSIBackTesting()` |  | GET | `/api/v5/tradingBot/public/rsi-back-testing` |
+| `getMaxGridQuantity()` |  | GET | `/api/v5/tradingBot/grid/grid-quantity` |
 | `createSignal()` | :closed_lock_with_key:  | POST | `/api/v5/tradingBot/signal/create-signal` |
 | `getSignals()` | :closed_lock_with_key:  | GET | `/api/v5/tradingBot/signal/signals` |
 | `createSignalBot()` | :closed_lock_with_key:  | POST | `/api/v5/tradingBot/signal/order-algo` |

package.json

@@ -1,6 +1,6 @@
 {
   "name": "okx-api",
-  "version": "1.4.3",
+  "version": "1.4.4",
   "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",

src/rest-client.ts

@@ -246,6 +246,7 @@ import {
   SetMmpConfigResult,
   OrderPrecheckRequest,
   AccountHistoryBill,
+  MaxGridQuantityRequest,
 } from './types';
 import { ASSET_BILL_TYPE } from './constants';
 
@@ -423,18 +424,36 @@ export class RestClient extends BaseRestClient {
     });
   }
 
+  /**
+   * @deprecated - Use getFeeRatesV2() instead, which uses an object for all parameters.
+   * In future, getFeeRates() will also use an object for params (breaking change if you continue using getFeeRates() as is)
+   */
   getFeeRates(
     instType: InstrumentType,
     instId?: string,
-    uly?: string
+    uly?: string,
+    instFamily?: string,
+    ruleType?: string
   ): Promise<AccountFeeRate[]> {
     return this.getPrivate('/api/v5/account/trade-fee', {
       instType,
       instId,
       uly,
+      instFamily,
+      ruleType,
     });
   }
 
+  getFeeRatesV2(params: {
+    instType: InstrumentType;
+    instId?: string;
+    uly?: string;
+    instFamily?: string;
+    ruleType?: string;
+  }): Promise<AccountFeeRate[]> {
+    return this.getPrivate('/api/v5/account/trade-fee', params);
+  }
+
   getInterestAccrued(params?: {
     type?: '1' | '2';
     ccy?: string;
@@ -1087,6 +1106,14 @@ export class RestClient extends BaseRestClient {
     return this.get('/api/v5/tradingBot/public/rsi-back-testing', params);
   }
 
+  getMaxGridQuantity(params: MaxGridQuantityRequest): Promise<
+    {
+      maxGridQty: string;
+    }[]
+  > {
+    return this.get('/api/v5/tradingBot/grid/grid-quantity', params);
+  }
+
   /**
    *
    * Orderbook trading - Signal bot trading endpoints

src/types/rest/request/grid-trading.ts

@@ -24,7 +24,6 @@ export interface GridAlgoTrigger {
   stopType?: '1' | '2';
 }
 
-
 export interface GridAlgoOrderRequest {
   instId: string;
   algoOrdType: GridAlgoOrderType;
@@ -65,3 +64,12 @@ export interface GetRSIBackTestingRequest {
   triggerCond?: 'cross_up' | 'cross_down' | 'above' | 'below' | 'cross';
   duration?: string;
 }
+
+export interface MaxGridQuantityRequest {
+  instId: string;
+  runType: '1' | '2';
+  algoOrdType: 'grid' | 'contract_grid';
+  maxPx: string;
+  minPx: string;
+  lever?: string;
+}

src/types/rest/response/private-account.ts

@@ -42,6 +42,13 @@ export interface AccountBalanceDetail {
   upl: string;
   uplLiab: string;
   stgyEq: string;
+  spotBal: string; // Spot balance. The unit is currency, e.g. BTC.
+  openAvgPx: string[]; // Spot average cost price. The unit is USD.
+  accAvgPx: string[]; // Spot accumulated cost price. The unit is USD.
+  spotUpl: string; // Spot unrealized profit and loss. The unit is USD.
+  spotUplRatio: string; // Spot unrealized profit and loss ratio.
+  totalPnl: string; // Spot accumulated profit and loss. The unit is USD.
+  totalPnlRatio: string; // Spot accumulated profit and loss ratio.
 }
 
 export interface AccountPosition {
@@ -256,6 +263,7 @@ export interface AccountFeeRate {
   taker: string;
   takerU: string;
   ts: string;
+  ruleType: string;
 }
 
 export interface AccountIsolatedMode {

src/types/rest/response/private-spread-trading.ts

@@ -21,7 +21,7 @@ export interface UpdateSpreadOrderResponse {
   sMsg: string;
 }
 
-export interface SpreadOrder  {
+export interface SpreadOrder {
   instId: string;
   ordId: string;
   clOrdId: string;
@@ -50,6 +50,7 @@ export interface SpreadTradeLeg {
   sz: string;
   side: 'buy' | 'sell';
   fee: string;
+  szCont: string;
   feeCcy: string;
   tradeId: string;
 }

src/types/rest/response/private-subaccount.ts

@@ -40,6 +40,13 @@ export interface SubAccountBalanceDetail {
   uTime: string;
   upl: string;
   uplLiab: string;
+  spotBal: string; // Spot balance. The unit is currency, e.g. BTC.
+  openAvgPx: string[]; // Spot average cost price. The unit is USD.
+  accAvgPx: string[]; // Spot accumulated cost price. The unit is USD.
+  spotUpl: string; // Spot unrealized profit and loss. The unit is USD.
+  spotUplRatio: string; // Spot unrealized profit and loss ratio.
+  totalPnl: string; // Spot accumulated profit and loss. The unit is USD.
+  totalPnlRatio: string; // Spot accumulated profit and loss ratio.
 }
 
 export interface SubAccountBalances {
@@ -75,4 +82,4 @@ export interface ManagedSubAccountTransfer {
   subAcct: string;
   subUid: string;
   ts: string;
-}
+}