Merge pull request #37 from JJ-Cro/update051124

v1.0.22 feat(): new endpoints, updated types

examples/apidoc/RestClient/batchCancelFuturesOrders.js

@@ -1,17 +1,18 @@
 const { RestClient } = require('gateio-api');
 
-  // This example shows how to call this Gate.io API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "gateio-api" for Gate.io exchange
-  // This Gate.io API SDK is available on npm via "npm install gateio-api"
-  // ENDPOINT: /futures/{settle}/batch_cancel_orders
-  // METHOD: POST
-  // PUBLIC: NO
+// This example shows how to call this Gate.io API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "gateio-api" for Gate.io exchange
+// This Gate.io API SDK is available on npm via "npm install gateio-api"
+// ENDPOINT: /futures/{settle}/batch_cancel_orders
+// METHOD: POST
+// PUBLIC: NO
 
 const client = new RestClient({
   apiKey: 'insert_api_key_here',
   apiSecret: 'insert_api_secret_here',
 });
 
-client.batchCancelFuturesOrders(params)
+client
+  .batchCancelFuturesOrders(params)
   .then((response) => {
     console.log(response);
   })

examples/apidoc/RestClient/getMultiLoanCurrentRates.js

@@ -0,0 +1,20 @@
+const { RestClient } = require('gateio-api');
+
+  // This example shows how to call this Gate.io API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "gateio-api" for Gate.io exchange
+  // This Gate.io API SDK is available on npm via "npm install gateio-api"
+  // ENDPOINT: /loan/multi_collateral/current_rate
+  // METHOD: GET
+  // PUBLIC: YES
+
+const client = new RestClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getMultiLoanCurrentRates(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/getUserCurrencyLeverageConfig.js

@@ -0,0 +1,20 @@
+const { RestClient } = require('gateio-api');
+
+  // This example shows how to call this Gate.io API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "gateio-api" for Gate.io exchange
+  // This Gate.io API SDK is available on npm via "npm install gateio-api"
+  // ENDPOINT: /unified/leverage/user_currency_config
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new RestClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getUserCurrencyLeverageConfig(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/getUserCurrencyLeverageSettings.js

@@ -0,0 +1,20 @@
+const { RestClient } = require('gateio-api');
+
+  // This example shows how to call this Gate.io API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "gateio-api" for Gate.io exchange
+  // This Gate.io API SDK is available on npm via "npm install gateio-api"
+  // ENDPOINT: /unified/leverage/user_currency_setting
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new RestClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getUserCurrencyLeverageSettings(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/updateUserCurrencyLeverage.js

@@ -0,0 +1,20 @@
+const { RestClient } = require('gateio-api');
+
+  // This example shows how to call this Gate.io API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "gateio-api" for Gate.io exchange
+  // This Gate.io API SDK is available on npm via "npm install gateio-api"
+  // ENDPOINT: /unified/leverage/user_currency_setting
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new RestClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.updateUserCurrencyLeverage(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gateio-api",
-  "version": "1.0.21",
+  "version": "1.0.22",
   "description": "Complete & robust Node.js SDK for Gate.io's REST APIs, WebSockets & WebSocket APIs, with TypeScript declarations.",
   "scripts": {
     "clean": "rm -rf dist/*",

src/RestClient.ts

@@ -195,6 +195,7 @@ import {
   BatchAmendOrderResp,
   DeleteFuturesBatchOrdersResp,
   FuturesAccount,
+  FuturesAccountBookRecord,
   FuturesAutoDeleveragingHistoryRecord,
   FuturesCandle,
   FuturesContract,
@@ -298,6 +299,7 @@ import {
   UnifiedLoan,
   UnifiedLoanRecord,
   UnifiedRiskUnitDetails,
+  UserCurrencyLeverageConfig,
 } from './types/response/unified.js';
 import {
   CreateDepositAddressResp,
@@ -1043,6 +1045,52 @@ export class RestClient extends BaseRestClient {
     return this.post('/unified/portfolio_calculator', { body: params });
   }
 
+  /**
+   * Query user currency leverage configuration
+   *
+   * Get the maximum and minimum leverage multiples that users can set for a currency type
+   *
+   * @param params Parameters containing the currency
+   * @returns Promise<UserCurrencyLeverageConfig>
+   */
+  getUserCurrencyLeverageConfig(params: {
+    currency: string;
+  }): Promise<UserCurrencyLeverageConfig> {
+    return this.getPrivate('/unified/leverage/user_currency_config', params);
+  }
+
+  /**
+   * Get the user's currency leverage
+   *
+   * If currency is not passed, query all currencies.
+   *
+   * @param params Optional parameters containing the currency
+   * @returns Promise<UserCurrencyLeverageSetting[]>
+   */
+  getUserCurrencyLeverageSettings(params?: { currency?: string }): Promise<
+    {
+      currency: string;
+      leverage: string;
+    }[]
+  > {
+    return this.getPrivate('/unified/leverage/user_currency_setting', params);
+  }
+
+  /**
+   * Set the currency leverage ratio
+   *
+   * @param params Parameters for setting currency leverage ratio
+   * @returns Promise<any> Returns nothing on success (204 No Content)
+   */
+  updateUserCurrencyLeverage(params: {
+    currency: string;
+    leverage: string;
+  }): Promise<any> {
+    return this.postPrivate('/unified/leverage/user_currency_setting', {
+      body: params,
+    });
+  }
+
   /**==========================================================================================================================
    * SPOT
    * ==========================================================================================================================
@@ -2130,7 +2178,7 @@ export class RestClient extends BaseRestClient {
    */
   getFuturesAccountBook(
     params: GetFuturesAccountBookReq,
-  ): Promise<GetFuturesAccountBookReq[]> {
+  ): Promise<FuturesAccountBookRecord[]> {
     const { settle, ...query } = params;
     return this.getPrivate(`/futures/${settle}/account_book`, query);
   }
@@ -2310,7 +2358,7 @@ export class RestClient extends BaseRestClient {
    * Set stp_act to decide the strategy of self-trade prevention. For detailed usage, refer to the stp_act parameter in the request body.
    *
    * @param params Parameters for creating a futures order
-   * @returns Promise<SubmitFuturesOrderReq>
+   * @returns Promise<FuturesOrder>
    */
   submitFuturesOrder(params: SubmitFuturesOrderReq): Promise<FuturesOrder> {
     const { settle, ...body } = params;
@@ -3790,6 +3838,27 @@ export class RestClient extends BaseRestClient {
     return this.get(`/loan/multi_collateral/fixed_rate`);
   }
 
+  /**
+   * Query the current interest rate of currencies
+   *
+   * Query the current interest rate of currencies in the last hour.
+   * The current interest rate is updated every hour.
+   *
+   * @param params Parameters containing currencies to query and optional VIP level
+   * @returns Promise<MultiLoanCurrentRate[]>
+   */
+  getMultiLoanCurrentRates(params: {
+    currencies: string[];
+    vip_level?: string;
+  }): Promise<
+    {
+      currency: string;
+      current_rate: string;
+    }[]
+  > {
+    return this.get('/loan/multi_collateral/current_rate', params);
+  }
+
   /**==========================================================================================================================
    * EARN
    * ==========================================================================================================================
@@ -3831,6 +3900,8 @@ export class RestClient extends BaseRestClient {
   submitDualInvestmentOrder(params: {
     plan_id: string;
     copies: string;
+    is_max: number;
+    amount: string;
   }): Promise<any> {
     return this.postPrivate(`/earn/dual/orders`, { body: params });
   }

src/types/response/futures.ts

@@ -143,6 +143,7 @@ export interface FuturesAccountBookRecord {
   text: string;
   contract?: string;
   trade_id: string;
+  id: string;
 }
 
 export interface UpdateFuturesDualModeResp {

src/types/response/spot.ts

@@ -18,7 +18,9 @@ export interface SpotTicker {
   currency_pair: string;
   last: string;
   lowest_ask: string;
+  lowest_size: string;
   highest_bid: string;
+  highest_size: string;
   change_percentage: string;
   change_utc0: string;
   change_utc8: string;

src/types/response/unified.ts

@@ -84,9 +84,20 @@ export interface UnifiedCurrencyDiscountTiers {
     discount: string;
     lower_limit: string;
     upper_limit: string;
+    leverage: string;
   }[];
 }
 
+export interface UserCurrencyLeverageConfig {
+  current_leverage: string;
+  min_leverage: string;
+  max_leverage: string;
+  debit: string;
+  available_margin: string;
+  borrowable: string;
+  except_leverage_borrowable: string;
+}
+
 export interface MarginTier {
   tier: string;
   margin_rate: string;