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

examples/apidoc/RestClient/adjustCollateral.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/finance/flexible-loan/adjust-collateral
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.adjustCollateral(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/amendLendingOrder.js

@@ -2,7 +2,7 @@ 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/finance/fixed-loan/lending-order
+  // ENDPOINT: /api/v5/finance/fixed-loan/amend-lending-order
   // METHOD: POST
   // PUBLIC: NO
 

examples/apidoc/RestClient/getAccountSwitchPrecheck.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-account-switch-precheck
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.getAccountSwitchPrecheck(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/getAccruedInterest.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/finance/flexible-loan/interest-accrued
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.getAccruedInterest(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/getBorrowableCurrencies.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/finance/flexible-loan/borrow-currencies
+  // METHOD: GET
+  // PUBLIC: YES
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.getBorrowableCurrencies(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/getCollateralAssets.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/finance/flexible-loan/collateral-assets
+  // METHOD: GET
+  // PUBLIC: YES
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.getCollateralAssets(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/getLoanHistory.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/finance/flexible-loan/loan-history
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.getLoanHistory(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/getLoanInfo.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/finance/flexible-loan/loan-info
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.getLoanInfo(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/getMaxLoanAmount.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/finance/flexible-loan/max-loan
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.getMaxLoanAmount(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/presetAccountLevelSwitch.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/account-level-switch-preset
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.presetAccountLevelSwitch(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

package.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",

src/rest-client.ts

@@ -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/types/rest/request/simple-earn.ts

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