gateio-api 1.1.0 → 1.1.1

package/dist/cjs/RestClient.d.ts

@@ -24,7 +24,7 @@ import { DeliveryAccount, DeliveryBook, DeliveryCandle, DeliveryClosedPosition,
 import { DualInvestmentOrder, DualInvestmentProduct, StructuredProduct, StructuredProductOrder } from './types/response/earn.js';
 import { LendingCurrency, LendingInterestRecord, LendingOrder, LendingRecord } from './types/response/earnuni.js';
 import { FlashSwapCurrencyPair, FlashSwapOrder, SubmitFlashSwapOrderPreviewResp } from './types/response/flashswap.js';
-import { BatchAmendOrderResp, DeleteFuturesBatchOrdersResp, FuturesAccount, FuturesAccountBookRecord, FuturesAutoDeleveragingHistoryRecord, FuturesCandle, FuturesContract, FuturesDeliveryContract, FuturesLiquidationHistoryRecord, FuturesOrder, FuturesOrderBook, FuturesPosition, FuturesPositionHistoryRecord, FuturesPriceTriggeredOrder, FuturesStats, FuturesTicker, FuturesTrade, FuturesTradingHistoryRecord, IndexConstituents, LiquidationHistoryRecord, PremiumIndexKLine, RiskLimitTier, UpdateFuturesDualModeResp } from './types/response/futures.js';
+import { BatchAmendOrderResp, DeleteFuturesBatchOrdersResp, FuturesAccount, FuturesAccountBookRecord, FuturesAutoDeleveragingHistoryRecord, FuturesCandle, FuturesContract, FuturesDeliveryContract, FuturesLiquidationHistoryRecord, FuturesOrder, FuturesOrderBook, FuturesPosition, FuturesPositionHistoryRecord, FuturesPriceTriggeredOrder, FuturesStats, FuturesTicker, FuturesTrade, FuturesTradingHistoryRecord, IndexConstituents, LiquidationHistoryRecord, PremiumIndexKLine, RiskLimitTier } from './types/response/futures.js';
 import { CrossMarginAccount, CrossMarginAccountHistoryRecord, CrossMarginCurrency, CrossMarginMorrowLoanRecord, MarginAccount, MarginBalanceHistoryRecord } from './types/response/margin.js';
 import { LendingMarket, MarginUNIInterestRecord, MarginUNILoan, MarginUNILoanRecord, MarginUNIMaxBorrowable } from './types/response/marginuni.js';
 import { MultiLoanAdjustmentRecord, MultiLoanCurrencyQuota, MultiLoanFixedRate, MultiLoanOrder, MultiLoanRatio, MultiLoanRepayRecord, MultiLoanSupportedCurrencies, RepayMultiLoanResp, UpdateMultiLoanResp } from './types/response/multicollateralLoan.js';
@@ -707,10 +707,14 @@ export declare class RestClient extends BaseRestClient {
      * - At most 4 currency pairs, maximum 10 orders each, are allowed in one request
      * - No mixture of spot orders and margin orders, i.e. account must be identical for all orders
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for creating a batch of orders
      * @returns Promise<SubmitSpotBatchOrdersResp[]>
      */
-    submitSpotBatchOrders(params: SpotOrder[]): Promise<SubmitSpotBatchOrdersResp[]>;
+    submitSpotBatchOrders(body: SpotOrder[], params?: {
+        xGateExptime?: number;
+    }): Promise<SubmitSpotBatchOrdersResp[]>;
     /**
      * List all open orders
      *
@@ -740,6 +744,8 @@ export declare class RestClient extends BaseRestClient {
      *
      * You can place orders with spot, portfolio, margin or cross margin account through setting the account field. It defaults to spot, which means spot account is used to place orders. If the user is using unified account, it defaults to the unified account.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for creating an order
      * @returns Promise<Order>
      */
@@ -759,6 +765,8 @@ export declare class RestClient extends BaseRestClient {
      * If account is not set, all open orders, including spot, portfolio, margin and cross margin ones, will be cancelled.
      * You can set account to cancel only orders within the specified account.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling all open orders in specified currency pair
      * @returns Promise<Order[]>
      */
@@ -767,16 +775,21 @@ export declare class RestClient extends BaseRestClient {
         side?: 'buy' | 'sell';
         account?: 'spot' | 'margin' | 'cross_margin' | 'unified';
         action_mode?: 'ACK' | 'RESULT' | 'FULL';
+        xGateExptime?: number;
     }): Promise<SpotOrder[]>;
     /**
      * Cancel a batch of orders with an ID list
      *
      * Multiple currency pairs can be specified, but maximum 20 orders are allowed per request.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling a batch of orders
      * @returns Promise<DeleteSpotBatchOrdersResp[]>
      */
-    batchCancelSpotOrders(params: CancelSpotBatchOrdersReq[]): Promise<DeleteSpotBatchOrdersResp[]>;
+    batchCancelSpotOrders(body: CancelSpotBatchOrdersReq[], params?: {
+        xGateExptime?: number;
+    }): Promise<DeleteSpotBatchOrdersResp[]>;
     /**
      * Get a single order
      *
@@ -793,6 +806,8 @@ export declare class RestClient extends BaseRestClient {
      *
      * Currently, only supports modification of price or amount fields.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for amending an order
      * @returns Promise<Order>
      */
@@ -802,6 +817,8 @@ export declare class RestClient extends BaseRestClient {
      *
      * Spot, portfolio and margin orders are cancelled by default. If trying to cancel cross margin orders or portfolio margin account are used, account must be set to cross_margin.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling a single order
      * @returns Promise<Order>
      */
@@ -848,10 +865,14 @@ export declare class RestClient extends BaseRestClient {
      *
      * Default modification of orders for spot, portfolio, and margin accounts. To modify orders for a cross margin account, the account parameter must be specified as cross_margin. For portfolio margin accounts, the account parameter can only be specified as cross_margin. Currently, only modifications to price or quantity (choose one) are supported.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for batch modification of orders
      * @returns Promise<Order[]>
      */
-    batchUpdateSpotOrders(params: UpdateSpotBatchOrdersReq[]): Promise<SpotOrder[]>;
+    batchUpdateSpotOrders(body: UpdateSpotBatchOrdersReq[], params?: {
+        xGateExptime?: number;
+    }): Promise<SpotOrder[]>;
     /**
      * Create a price-triggered order
      *
@@ -1439,12 +1460,12 @@ export declare class RestClient extends BaseRestClient {
      * Before setting dual mode, make sure all positions are closed and no orders are open.
      *
      * @param params Parameters for enabling or disabling dual mode
-     * @returns Promise<ToggleFuturesDualModeResp>
+     * @returns Promise<FuturesAccount>
      */
     updateFuturesDualMode(params: {
         settle: 'btc' | 'usdt' | 'usd';
         dual_mode: boolean;
-    }): Promise<UpdateFuturesDualModeResp>;
+    }): Promise<FuturesAccount>;
     /**
      * Retrieve position detail in dual mode
      *
@@ -1490,6 +1511,8 @@ export declare class RestClient extends BaseRestClient {
      * In dual position mode, to close one side position, you need to set auto_size side, reduce_only to true, and size to 0.
      * Set stp_act to decide the strategy of self-trade prevention. For detailed usage, refer to the stp_act parameter in the request body.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for creating a futures order
      * @returns Promise<FuturesOrder>
      */
@@ -1509,6 +1532,8 @@ export declare class RestClient extends BaseRestClient {
      *
      * Zero-filled order cannot be retrieved 10 minutes after order cancellation.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling all open orders matched
      * @returns Promise<FuturesOrder[]>
      */
@@ -1531,10 +1556,13 @@ export declare class RestClient extends BaseRestClient {
      * If the execution is successful, the normal order content is included; if the execution fails, the label field is included to indicate the cause of the error.
      * In the rate limiting, each order is counted individually.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for creating a batch of futures orders
      * @returns Promise<FuturesOrder[]>
      */
     submitFuturesBatchOrders(params: {
+        xGateExptime?: number;
         settle: 'btc' | 'usdt' | 'usd';
         orders: SubmitFuturesOrderReq[];
     }): Promise<FuturesOrder[]>;
@@ -1554,16 +1582,21 @@ export declare class RestClient extends BaseRestClient {
     /**
      * Cancel a single order
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling a single order
      * @returns Promise<FuturesOrder>
      */
     cancelFuturesOrder(params: {
+        xGateExptime?: number;
         settle: 'btc' | 'usdt' | 'usd';
         order_id: string;
     }): Promise<FuturesOrder>;
     /**
      * Amend an order
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for amending an order
      * @returns Promise<FuturesOrder>
      */
@@ -1639,10 +1672,13 @@ export declare class RestClient extends BaseRestClient {
      *
      * Multiple distinct order ID list can be specified. Each request can cancel a maximum of 20 records.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling a batch of orders with an ID list
      * @returns Promise<DeleteFuturesBatchOrdersResp[]>
      */
     batchCancelFuturesOrders(params: {
+        xGateExptime?: number;
         settle: 'btc' | 'usdt' | 'usd';
         orderIds: string[];
     }): Promise<DeleteFuturesBatchOrdersResp[]>;
@@ -1651,11 +1687,17 @@ export declare class RestClient extends BaseRestClient {
      *
      * You can specify multiple different order IDs. You can only modify up to 10 orders in one request.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Array of BatchAmendOrderReq objects
      * @param settle Settlement currency (e.g., 'btc', 'usdt', 'usd')
      * @returns Promise<BatchAmendOrderResp[]>
      */
-    batchUpdateFuturesOrders(settle: 'btc' | 'usdt' | 'usd', params: BatchAmendOrderReq[]): Promise<BatchAmendOrderResp[]>;
+    batchUpdateFuturesOrders(params: {
+        xGateExptime?: number;
+        settle: 'btc' | 'usdt' | 'usd';
+        orders: BatchAmendOrderReq[];
+    }): Promise<BatchAmendOrderResp[]>;
     /**
      * Create a price-triggered order
      *

package/dist/cjs/RestClient.js

@@ -748,11 +748,20 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      * - At most 4 currency pairs, maximum 10 orders each, are allowed in one request
      * - No mixture of spot orders and margin orders, i.e. account must be identical for all orders
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for creating a batch of orders
      * @returns Promise<SubmitSpotBatchOrdersResp[]>
      */
-    submitSpotBatchOrders(params) {
-        return this.postPrivate('/spot/batch_orders', { body: params });
+    submitSpotBatchOrders(body, params) {
+        const { xGateExptime } = params || {};
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
+        return this.postPrivate('/spot/batch_orders', {
+            headers: headers,
+            body: body,
+        });
     }
     /**
      * List all open orders
@@ -783,11 +792,17 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      *
      * You can place orders with spot, portfolio, margin or cross margin account through setting the account field. It defaults to spot, which means spot account is used to place orders. If the user is using unified account, it defaults to the unified account.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for creating an order
      * @returns Promise<Order>
      */
     submitSpotOrder(params) {
-        return this.postPrivate('/spot/orders', { body: params });
+        const { xGateExptime, ...body } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
+        return this.postPrivate('/spot/orders', { headers: headers, body: body });
     }
     /**
      * List orders
@@ -806,22 +821,40 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      * If account is not set, all open orders, including spot, portfolio, margin and cross margin ones, will be cancelled.
      * You can set account to cancel only orders within the specified account.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling all open orders in specified currency pair
      * @returns Promise<Order[]>
      */
     cancelSpotOpenOrders(params) {
-        return this.deletePrivate('/spot/orders', { query: params });
+        const { xGateExptime, ...query } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
+        return this.deletePrivate('/spot/orders', {
+            headers: headers,
+            query: query,
+        });
     }
     /**
      * Cancel a batch of orders with an ID list
      *
      * Multiple currency pairs can be specified, but maximum 20 orders are allowed per request.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling a batch of orders
      * @returns Promise<DeleteSpotBatchOrdersResp[]>
      */
-    batchCancelSpotOrders(params) {
-        return this.postPrivate('/spot/cancel_batch_orders', { body: params });
+    batchCancelSpotOrders(body, params) {
+        const { xGateExptime } = params || {};
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
+        return this.postPrivate('/spot/cancel_batch_orders', {
+            headers: headers,
+            body: body,
+        });
     }
     /**
      * Get a single order
@@ -842,16 +875,22 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      *
      * Currently, only supports modification of price or amount fields.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for amending an order
      * @returns Promise<Order>
      */
     updateSpotOrder(params) {
-        const { order_id, currency_pair, account, ...body } = params;
+        const { xGateExptime, order_id, currency_pair, account, ...body } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
         const query = {
             currency_pair: currency_pair,
             account: account,
         };
         return this.patchPrivate(`/spot/orders/${order_id}`, {
+            headers: headers,
             query: query,
             body: body,
         });
@@ -861,12 +900,18 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      *
      * Spot, portfolio and margin orders are cancelled by default. If trying to cancel cross margin orders or portfolio margin account are used, account must be set to cross_margin.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling a single order
      * @returns Promise<Order>
      */
     cancelSpotOrder(params) {
-        const { order_id, ...query } = params;
+        const { xGateExptime, order_id, ...query } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
         return this.deletePrivate(`/spot/orders/${order_id}`, {
+            headers: headers,
             query: query,
         });
     }
@@ -911,11 +956,20 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      *
      * Default modification of orders for spot, portfolio, and margin accounts. To modify orders for a cross margin account, the account parameter must be specified as cross_margin. For portfolio margin accounts, the account parameter can only be specified as cross_margin. Currently, only modifications to price or quantity (choose one) are supported.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for batch modification of orders
      * @returns Promise<Order[]>
      */
-    batchUpdateSpotOrders(params) {
-        return this.postPrivate('/spot/amend_batch_orders', { body: params });
+    batchUpdateSpotOrders(body, params) {
+        const { xGateExptime } = params || {};
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
+        return this.postPrivate('/spot/amend_batch_orders', {
+            headers: headers,
+            body: body,
+        });
     }
     /**
      * Create a price-triggered order
@@ -1529,7 +1583,7 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      * Before setting dual mode, make sure all positions are closed and no orders are open.
      *
      * @param params Parameters for enabling or disabling dual mode
-     * @returns Promise<ToggleFuturesDualModeResp>
+     * @returns Promise<FuturesAccount>
      */
     updateFuturesDualMode(params) {
         const { settle, ...query } = params;
@@ -1586,12 +1640,20 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      * In dual position mode, to close one side position, you need to set auto_size side, reduce_only to true, and size to 0.
      * Set stp_act to decide the strategy of self-trade prevention. For detailed usage, refer to the stp_act parameter in the request body.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for creating a futures order
      * @returns Promise<FuturesOrder>
      */
     submitFuturesOrder(params) {
-        const { settle, ...body } = params;
-        return this.postPrivate(`/futures/${settle}/orders`, { body: body });
+        const { xGateExptime, settle, ...body } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
+        return this.postPrivate(`/futures/${settle}/orders`, {
+            headers: headers,
+            body: body,
+        });
     }
     /**
      * List futures orders
@@ -1611,12 +1673,18 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      *
      * Zero-filled order cannot be retrieved 10 minutes after order cancellation.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling all open orders matched
      * @returns Promise<FuturesOrder[]>
      */
     cancelAllFuturesOrders(params) {
-        const { settle, ...query } = params;
+        const { xGateExptime, settle, ...query } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
         return this.deletePrivate(`/futures/${settle}/orders`, {
+            headers: headers,
             query: query,
         });
     }
@@ -1641,12 +1709,18 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      * If the execution is successful, the normal order content is included; if the execution fails, the label field is included to indicate the cause of the error.
      * In the rate limiting, each order is counted individually.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for creating a batch of futures orders
      * @returns Promise<FuturesOrder[]>
      */
     submitFuturesBatchOrders(params) {
-        const { settle, orders } = params;
+        const { xGateExptime, settle, orders } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
         return this.postPrivate(`/futures/${settle}/batch_orders`, {
+            headers: headers,
             body: orders,
         });
     }
@@ -1665,21 +1739,30 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
     /**
      * Cancel a single order
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling a single order
      * @returns Promise<FuturesOrder>
      */
     cancelFuturesOrder(params) {
-        return this.deletePrivate(`/futures/${params.settle}/orders/${params.order_id}`);
+        const { xGateExptime, settle, order_id } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
+        return this.deletePrivate(`/futures/${settle}/orders/${order_id}`, {
+            headers: headers,
+        });
     }
     /**
      * Amend an order
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for amending an order
      * @returns Promise<FuturesOrder>
      */
     updateFuturesOrder(params) {
-        const { settle, order_id, ...rest } = params;
-        const { ['x-gate-exptime']: xGateExptime, ...body } = rest;
+        const { xGateExptime, settle, order_id, ...body } = params;
         const headers = xGateExptime
             ? { 'x-gate-exptime': xGateExptime }
             : undefined;
@@ -1773,12 +1856,18 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      *
      * Multiple distinct order ID list can be specified. Each request can cancel a maximum of 20 records.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Parameters for cancelling a batch of orders with an ID list
      * @returns Promise<DeleteFuturesBatchOrdersResp[]>
      */
     batchCancelFuturesOrders(params) {
-        const { settle, ...orderIds } = params;
+        const { xGateExptime, settle, orderIds } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
         return this.postPrivate(`/futures/${settle}/batch_cancel_orders`, {
+            headers: headers,
             body: orderIds,
         });
     }
@@ -1787,13 +1876,20 @@ class RestClient extends BaseRestClient_js_1.BaseRestClient {
      *
      * You can specify multiple different order IDs. You can only modify up to 10 orders in one request.
      *
+     * NOTE: The "xGateExptime" parameter will translate to the "x-gate-exptime" header.
+     *
      * @param params Array of BatchAmendOrderReq objects
      * @param settle Settlement currency (e.g., 'btc', 'usdt', 'usd')
      * @returns Promise<BatchAmendOrderResp[]>
      */
-    batchUpdateFuturesOrders(settle, params) {
+    batchUpdateFuturesOrders(params) {
+        const { xGateExptime, settle, orders } = params;
+        const headers = xGateExptime
+            ? { 'x-gate-exptime': xGateExptime }
+            : undefined;
         return this.postPrivate(`/futures/${settle}/batch_amend_orders`, {
-            body: params,
+            headers: headers,
+            body: orders,
         });
     }
     /**