Merge pull request #144 from JJ-Cro/update02102025

feat(v3.0.7): Expand RFQ types and settle/fee endpoints

Author: tiagosiebler

docs/endpointFunctionList.md

@@ -0,0 +1,21 @@
+const { RestClient } = require('okx-api');
+
+  // This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
+  // This OKX API SDK is available on npm via "npm install okx-api"
+  // ENDPOINT: /api/v5/account/set-fee-type
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.setFeeType(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/setFeeType.js

@@ -0,0 +1,21 @@
+const { RestClient } = require('okx-api');
+
+  // This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
+  // This OKX API SDK is available on npm via "npm install okx-api"
+  // ENDPOINT: /api/v5/account/set-settle-currency
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.setSettleCurrency(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/setSettleCurrency.js

@@ -1,6 +1,6 @@
 {
   "name": "okx-api",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "description": "Complete Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests",
   "scripts": {
     "test": "jest",

package-lock.json

@@ -13,8 +13,10 @@ import {
   GetVIPLoanOrderListRequest,
   PositionBuilderRequest,
   QuickMarginBorrowRepayRequest,
+  SetFeeTypeRequest,
   SetLeverageRequest,
   SetMMPConfigRequest,
+  SetSettleCurrencyRequest,
   SubmitFixedLoanBorrowingOrderRequest,
   UpdateFixedLoanBorrowingOrderRequest,
   WithdrawalHistoryRequest,
@@ -165,7 +167,9 @@ import {
   MMPConfig,
   QuickMarginBorrowRepayRecord,
   QuickMarginBorrowRepayResult,
+  SetFeeTypeResult,
   SetMMPConfigResult,
+  SetSettleCurrencyResult,
   VIPInterest,
   VIPLoanOrder,
   VIPLoanOrderDetail,
@@ -175,6 +179,7 @@ import {
   BlockMakerInstrumentSettings,
   BlockMMPConfig,
   BlockRFQResult,
+  BlockTradeResult,
   CancelBlockQuoteResult,
   CancelBlockRFQResult,
   CreateBlockQuoteResult,
@@ -467,6 +472,16 @@ export class RestClient extends BaseRestClient {
     return this.postPrivate('/api/v5/account/set-position-mode', params);
   }
 
+  setSettleCurrency(
+    params: SetSettleCurrencyRequest,
+  ): Promise<SetSettleCurrencyResult[]> {
+    return this.postPrivate('/api/v5/account/set-settle-currency', params);
+  }
+
+  setFeeType(params: SetFeeTypeRequest): Promise<SetFeeTypeResult[]> {
+    return this.postPrivate('/api/v5/account/set-fee-type', params);
+  }
+
   setLeverage(params: SetLeverageRequest): Promise<AccountLeverageResult[]> {
     return this.postPrivate('/api/v5/account/set-leverage', params);
   }
@@ -1920,11 +1935,11 @@ export class RestClient extends BaseRestClient {
     return this.getPrivate('/api/v5/rfq/quotes', params);
   }
 
-  getBlockTrades(params?: any): Promise<any[]> {
+  getBlockTrades(params?: any): Promise<BlockTradeResult[]> {
     return this.getPrivate('/api/v5/rfq/trades', params);
   }
 
-  getPublicRFQBlockTrades(params?: any): Promise<any[]> {
+  getPublicRFQBlockTrades(params?: any): Promise<PublicBlockTrade[]> {
     return this.get('/api/v5/rfq/public-trades', params);
   }
 

package.json

@@ -165,3 +165,11 @@ export interface SetMMPConfigRequest {
   frozenInterval: string;
   qtyLimit: string;
 }
+
+export interface SetSettleCurrencyRequest {
+  settleCcy: string;
+}
+
+export interface SetFeeTypeRequest {
+  feeType: '0' | '1';
+}

src/rest-client.ts

@@ -1,10 +1,25 @@
 import { OrderSide, RFQLeg } from '../shared.js';
+export interface AccountAllocationLeg {
+  sz: string;
+  instId: string;
+  tdMode?: string;
+  ccy?: string;
+  posSide?: string;
+}
+
+export interface AccountAllocation {
+  acct: string;
+  legs: AccountAllocationLeg[];
+}
 
 export interface CreateBlockRFQRequest {
   counterparties: string[];
   anonymous?: boolean;
   clRfqId?: string;
+  tag?: string;
+  allowPartialExecution?: boolean;
   legs: RFQLeg[];
+  acctAlloc?: AccountAllocation[];
 }
 
 export interface CancelBlockRFQRequest {

src/types/rest/request/account.ts

@@ -120,8 +120,9 @@ export interface AmendAlgoOrderRequest {
 }
 
 export interface CancelAlgoOrderRequest {
-  algoId: string;
   instId: string;
+  algoId?: string;
+  algoClOrdId?: string;
 }
 
 export interface ClosePositionRequest {

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

@@ -55,6 +55,7 @@ export interface AccountBalance {
   uTime: string;
   spotCopyTradingEq: string;
   upl: string;
+  frpType?: string;
 }
 
 export interface AccountPosition {
@@ -169,6 +170,8 @@ export interface AccountBill {
   to: string;
   ts: string;
   type: string;
+  earnAmt?: string;
+  earnApr?: string;
 }
 
 export interface AccountHistoryBill {
@@ -201,6 +204,9 @@ export interface AccountConfiguration {
   discountType: '0' | '1';
   enableSpotBorrow: boolean;
   spotBorrowAutoRepay: boolean;
+  feeType: string;
+  settleCcy: string;
+  settleCcyList: string[];
 }
 
 export interface AccountPositionModeResult {
@@ -493,3 +499,11 @@ export interface GetCollateralAssetsResult {
   ccy: string;
   collateralEnabled: boolean;
 }
+
+export interface SetSettleCurrencyResult {
+  settleCcy: string;
+}
+
+export interface SetFeeTypeResult {
+  feeType: string;
+}