@binance/margin-trading 13.0.5 → 13.1.0

package/dist/index.js

@@ -14,7 +14,7 @@ let __binance_common = require("@binance/common");
 
 //#region package.json
 var name = "@binance/margin-trading";
-var version = "13.0.5";
+var version = "13.1.0";
 
 //#endregion
 //#region src/rest-api/modules/account-api.ts
@@ -247,7 +247,7 @@ var AccountApi = class {
 	* Security Type: USER_DATA
 	*
 	* Notes:
-	* - The margin level need higher than the initial risk ratio of adjusted leverage, the initial risk ratio of 3x is 1.5 , the initial risk ratio of 5x is 1.25; The detail conditions on how to switch between Cross Margin Classic and Cross Margin Pro can refer to [the FAQ](https://www.binance.com/en/support/faq/how-to-activate-the-cross-margin-pro-mode-on-binance-e27786da05e743a694b8c625b3bc475d).
+	* - The margin level need higher than the initial risk ratio of adjusted leverage, the initial risk ratio of 3x is 1.5 , the initial risk ratio of 5x is 1.25; The detail conditions on how to switch between Cross Margin Classic and Cross Margin Pro can refer to the FAQ.
 	*
 	* @summary Adjust cross margin max leverage (USER_DATA)
 	* @param {AdjustCrossMarginMaxLeverageRequest} requestParameters Request parameters.
@@ -344,8 +344,21 @@ var AccountApi = class {
 	*
 	* - The time between startTime and endTime cannot be longer than 7 days.
 	*
-	* - If fromId is set, the data with id > fromId will be returned.
-	* Otherwise the latest data will be returned
+	* - If both startTime and endTime are omitted, the most recent 7 days are
+	* queried (endTime defaults to the current time, and startTime to the
+	* current time minus 7 days).
+	*
+	* - If startTime is provided without endTime, endTime defaults to
+	* startTime plus 7 days.
+	*
+	* - If endTime is provided without startTime, startTime defaults to
+	* endTime minus 7 days.
+	*
+	* - If fromId is set, the data with id > fromId within the queried time
+	* range will be returned. Otherwise the latest data within that range will
+	* be returned. fromId does not extend the time range; to retrieve older
+	* records, move startTime and endTime backwards in windows of up to 7
+	* days.
 	*
 	* - To query isolated data, Symbol needs to be entered.
 	*
@@ -786,7 +799,7 @@ var BorrowRepayApi = class {
 	*
 	* Notes:
 	* - If isolatedSymbol is not sent, crossed margin data will be sent.
-	* - `borrowLimit` is also available from [https://www.binance.com/en/margin-fee](https://www.binance.com/en/margin-fee)
+	* - `borrowLimit` is also available from https://www.binance.com/en/margin-fee
 	*
 	* @summary Query Max Borrow (USER_DATA)
 	* @param {QueryMaxBorrowRequest} requestParameters Request parameters.
@@ -1895,6 +1908,23 @@ const TradeApiAxiosParamCreator = function(configuration) {
 				timeUnit: _timeUnit
 			};
 		},
+		queryMarginAccountsOpenOtootocoOrderLists: async (symbol, recvWindow) => {
+			const localVarQueryParameter = {};
+			const localVarBodyParameter = {};
+			const localVarHeaderParameter = {};
+			if (symbol !== void 0 && symbol !== null) localVarQueryParameter["symbol"] = symbol;
+			if (recvWindow !== void 0 && recvWindow !== null) localVarQueryParameter["recvWindow"] = recvWindow;
+			let _timeUnit;
+			if ("timeUnit" in configuration) _timeUnit = configuration.timeUnit;
+			return {
+				endpoint: "/sapi/v1/margin/oto/openOrderList",
+				method: "GET",
+				queryParams: localVarQueryParameter,
+				bodyParams: localVarBodyParameter,
+				headerParams: localVarHeaderParameter,
+				timeUnit: _timeUnit
+			};
+		},
 		queryMarginAccountsOrder: async (symbol, isIsolated, orderId, origClientOrderId, recvWindow) => {
 			(0, __binance_common.assertParamExists)("queryMarginAccountsOrder", "symbol", symbol);
 			const localVarQueryParameter = {};
@@ -2028,12 +2058,12 @@ var TradeApi = class {
 	/**
 	* **Eligibility**
 	*
-	* - Binance Margin offers low-latency trading through a [special key](https://www.binance.com/en/support/faq/frequently-asked-questions-on-margin-special-api-key-3208663e900d4d2e9fec4140e1832f4e), available exclusively to users with VIP level 7 or higher.
+	* - Binance Margin offers low-latency trading through a special key, available exclusively to users with VIP level 7 or higher.
 	* - If you are VIP level 6 or below, please contact your VIP manager for eligibility criterias.
 	* - All new Margin Special Key users are required to read, understand, and agree to the Margin Special Key Supplemental Product Terms at the master account level before creating a Margin Special Key.
 	* - Once signed at the master account level, the agreement applies to all sub-accounts. The master account and all sub-accounts (Cross Margin Classic and Portfolio Margin Pro) are authorized to create a Margin Special Key and are subject to the LiquidationLoan policy.
 	*
-	* For more information, please refer to [FAQ](https://www.binance.com/en/support/faq/detail/3208663e900d4d2e9fec4140e1832f4e).
+	* For more information, please refer to FAQ.
 	*
 	**Supported Products:**
 	*
@@ -2051,7 +2081,7 @@ var TradeApi = class {
 	* HMAC
 	* RSA
 	*
-	* We recommend to **use Ed25519 API keys** as it should provide the best performance and security out of all supported key types. We accept PKCS#8 (BEGIN PUBLIC KEY). For how to generate an RSA key pair to send API requests on Binance. Please refer to the document below [FAQ](https://www.binance.com/en/support/faq/how-to-generate-an-rsa-key-pair-to-send-api-requests-on-binance-2b79728f331e43079b27440d9d15c5db) .
+	* We recommend to **use Ed25519 API keys** as it should provide the best performance and security out of all supported key types. We accept PKCS#8 (BEGIN PUBLIC KEY). For how to generate an RSA key pair to send API requests on Binance. Please refer to the document below FAQ .
 	*
 	**How to use the Margin Special Key**
 	* - Use the below `sapi` endpoint to create your margin special API Key.
@@ -2059,7 +2089,7 @@ var TradeApi = class {
 	* - For accessing the Isolated Margin account(s), pass the relevant `symbol` parameter in the API Key creation request.
 	* - Use the generated API Key (and Secret key, if applicable) to perform margin trading and listenKey generation via **Spot** REST API (`https://api.binance.com/api/v3/*`) endpoints.
 	*
-	* Read [REST API](/products/spot/rest-api#signed-trade-and-user_data-endpoint-security) or [WebSocket API](/products/spot/web-socket-api#request-security) documentation to learn how to use different API keys
+	* Read REST API or WebSocket API documentation to learn how to use different API keys
 	*
 	* You need to enable Permits “Enable Spot & Margin Trading” option for the API Key which requests this endpoint.
 	*
@@ -2151,7 +2181,7 @@ var TradeApi = class {
 	* 2. All pre-execution margin checks (including Open-order-loss calculation) will revert to standard mode.
 	* 3. A cooldown period (default: 24 hours) will be enforced, during which the account will not be permitted to create new Margin Special API Keys.
 	*
-	* For more information, please refer to [FAQ](https://www.binance.com/en/support/faq/detail/3208663e900d4d2e9fec4140e1832f4e).
+	* For more information, please refer to FAQ.
 	*
 	**Preconditions:**
 	*
@@ -2390,8 +2420,15 @@ var TradeApi = class {
 	*
 	* Notes:
 	* - autoRepayAtCancel is suggested to set as “FALSE” to keep liability unrepaid under high frequent new order/cancel order execution
-	* - Depending on the `pendingType` or `workingType`, some optional
-	* - parameters will become mandatory: | Type                                                     | Additional mandatory parameters                              | Additional information | | -------------------------------------------------------- | ------------------------------------------------------------ | ---------------------- | | `workingType` = `LIMIT`                                  | `workingTimeInForce`                                         |                        | | `pendingType` = `LIMIT`                                  | `pendingPrice`, `pendingTimeInForce`                         |                        | | `pendingType` = `STOP_LOSS` or `TAKE_PROFIT`             | `pendingStopPrice` and/or `pendingTrailingDelta`             |                        | | `pendingType` = `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` | `pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce` |                        | | `pendingTrailingDelta` is provided | `pendingPrice` |                        |
+	* - Depending on the `pendingType` or `workingType`, some optional parameters will become mandatory:
+	*
+	* | Type | Additional mandatory parameters | Additional information |
+	* | --- | --- | --- |
+	* | `workingType` = `LIMIT` | `workingTimeInForce` | |
+	* | `pendingType` = `LIMIT` | `pendingPrice`, `pendingTimeInForce` | |
+	* | `pendingType` = `STOP_LOSS` or `TAKE_PROFIT` | `pendingStopPrice` and/or `pendingTrailingDelta` | |
+	* | `pendingType` = `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` | `pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce` | |
+	* | `pendingTrailingDelta` is provided | `pendingPrice` | |
 	*
 	* @summary Margin Account New OTO (TRADE)
 	* @param {MarginAccountNewOtoRequest} requestParameters Request parameters.
@@ -2407,7 +2444,6 @@ var TradeApi = class {
 	/**
 	* Post a new OTOCO order for margin account：
 	*
-	*
 	* - An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list
 	* comprised of 3 orders.
 	*
@@ -2417,7 +2453,7 @@ var TradeApi = class {
 	* - OTOCO has 2 pending orders (pending above and pending below), forming
 	* an OCO pair. The pending orders are only placed on the order book when
 	* the working order gets **fully filled**.
-	* - The rules of the pending above and pending below follow the same rules as the [Order List OCO](https://developers.binance.com/en/docs/catalog/core-trading-margin-trading/api/rest-api/trade#margin-account-new-oco).
+	* - The rules of the pending above and pending below follow the same rules as the Order List OCO.
 	* - OTOCOs add **3 orders** against the unfilled order count,
 	* `EXCHANGE_MAX_NUM_ORDERS` filter, and `MAX_NUM_ORDERS` filter.
 	*
@@ -2630,6 +2666,30 @@ var TradeApi = class {
 		return (0, __binance_common.sendRequest)(this.configuration, localVarAxiosArgs.endpoint, localVarAxiosArgs.method, localVarAxiosArgs.queryParams, localVarAxiosArgs.bodyParams, localVarAxiosArgs.headerParams, localVarAxiosArgs?.timeUnit, { isSigned: true });
 	}
 	/**
+	* Retrieves all open OTO / OTOCO order lists of the margin account.
+	*
+	*
+	* Notes:
+	* - The returned list contains order lists whose `listOrderStatus` is `EXECUTING`, i.e. at least one order of the list is still open (`NEW` / `PARTIALLY_FILLED`).
+	* - For OTO, the `orders` array contains 2 orders: the working order and the pending order.
+	* - For OTOCO, the `orders` array contains 3 orders: the working order and the two pending orders (pending above / pending below).
+	*
+	* Weight(UID): 10
+	*
+	* Security Type: USER_DATA
+	*
+	* @summary Query Margin Account\'s Open OTO/OTOCO Order Lists (USER_DATA)
+	* @param {QueryMarginAccountsOpenOtootocoOrderListsRequest} requestParameters Request parameters.
+	* @returns {Promise<RestApiResponse<QueryMarginAccountsOpenOtootocoOrderListsResponse>>}
+	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+	* @memberof TradeApi
+	* @see {@link https://developers.binance.com/en/docs/catalog/core-trading-margin-trading/api/rest-api/trade#query-margin-accounts-open-otootoco-order-lists Binance API Documentation}
+	*/
+	async queryMarginAccountsOpenOtootocoOrderLists(requestParameters = {}) {
+		const localVarAxiosArgs = await this.localVarAxiosParamCreator.queryMarginAccountsOpenOtootocoOrderLists(requestParameters?.symbol, requestParameters?.recvWindow);
+		return (0, __binance_common.sendRequest)(this.configuration, localVarAxiosArgs.endpoint, localVarAxiosArgs.method, localVarAxiosArgs.queryParams, localVarAxiosArgs.bodyParams, localVarAxiosArgs.headerParams, localVarAxiosArgs?.timeUnit, { isSigned: true });
+	}
+	/**
 	* Query Margin Account's Order
 	*
 	* Weight(IP): 10
@@ -3369,7 +3429,7 @@ var RestAPI = class {
 	* Security Type: USER_DATA
 	*
 	* Notes:
-	* - The margin level need higher than the initial risk ratio of adjusted leverage, the initial risk ratio of 3x is 1.5 , the initial risk ratio of 5x is 1.25; The detail conditions on how to switch between Cross Margin Classic and Cross Margin Pro can refer to [the FAQ](https://www.binance.com/en/support/faq/how-to-activate-the-cross-margin-pro-mode-on-binance-e27786da05e743a694b8c625b3bc475d).
+	* - The margin level need higher than the initial risk ratio of adjusted leverage, the initial risk ratio of 3x is 1.5 , the initial risk ratio of 5x is 1.25; The detail conditions on how to switch between Cross Margin Classic and Cross Margin Pro can refer to the FAQ.
 	*
 	* @summary Adjust cross margin max leverage (USER_DATA)
 	* @param {AdjustCrossMarginMaxLeverageRequest} requestParameters Request parameters.
@@ -3461,8 +3521,21 @@ var RestAPI = class {
 	*
 	* - The time between startTime and endTime cannot be longer than 7 days.
 	*
-	* - If fromId is set, the data with id > fromId will be returned.
-	* Otherwise the latest data will be returned
+	* - If both startTime and endTime are omitted, the most recent 7 days are
+	* queried (endTime defaults to the current time, and startTime to the
+	* current time minus 7 days).
+	*
+	* - If startTime is provided without endTime, endTime defaults to
+	* startTime plus 7 days.
+	*
+	* - If endTime is provided without startTime, startTime defaults to
+	* endTime minus 7 days.
+	*
+	* - If fromId is set, the data with id > fromId within the queried time
+	* range will be returned. Otherwise the latest data within that range will
+	* be returned. fromId does not extend the time range; to retrieve older
+	* records, move startTime and endTime backwards in windows of up to 7
+	* days.
 	*
 	* - To query isolated data, Symbol needs to be entered.
 	*
@@ -3710,7 +3783,7 @@ var RestAPI = class {
 	*
 	* Notes:
 	* - If isolatedSymbol is not sent, crossed margin data will be sent.
-	* - `borrowLimit` is also available from [https://www.binance.com/en/margin-fee](https://www.binance.com/en/margin-fee)
+	* - `borrowLimit` is also available from https://www.binance.com/en/margin-fee
 	*
 	* @summary Query Max Borrow (USER_DATA)
 	* @param {QueryMaxBorrowRequest} requestParameters Request parameters.
@@ -3957,12 +4030,12 @@ var RestAPI = class {
 	/**
 	* **Eligibility**
 	*
-	* - Binance Margin offers low-latency trading through a [special key](https://www.binance.com/en/support/faq/frequently-asked-questions-on-margin-special-api-key-3208663e900d4d2e9fec4140e1832f4e), available exclusively to users with VIP level 7 or higher.
+	* - Binance Margin offers low-latency trading through a special key, available exclusively to users with VIP level 7 or higher.
 	* - If you are VIP level 6 or below, please contact your VIP manager for eligibility criterias.
 	* - All new Margin Special Key users are required to read, understand, and agree to the Margin Special Key Supplemental Product Terms at the master account level before creating a Margin Special Key.
 	* - Once signed at the master account level, the agreement applies to all sub-accounts. The master account and all sub-accounts (Cross Margin Classic and Portfolio Margin Pro) are authorized to create a Margin Special Key and are subject to the LiquidationLoan policy.
 	*
-	* For more information, please refer to [FAQ](https://www.binance.com/en/support/faq/detail/3208663e900d4d2e9fec4140e1832f4e).
+	* For more information, please refer to FAQ.
 	*
 	**Supported Products:**
 	*
@@ -3980,7 +4053,7 @@ var RestAPI = class {
 	* HMAC
 	* RSA
 	*
-	* We recommend to **use Ed25519 API keys** as it should provide the best performance and security out of all supported key types. We accept PKCS#8 (BEGIN PUBLIC KEY). For how to generate an RSA key pair to send API requests on Binance. Please refer to the document below [FAQ](https://www.binance.com/en/support/faq/how-to-generate-an-rsa-key-pair-to-send-api-requests-on-binance-2b79728f331e43079b27440d9d15c5db) .
+	* We recommend to **use Ed25519 API keys** as it should provide the best performance and security out of all supported key types. We accept PKCS#8 (BEGIN PUBLIC KEY). For how to generate an RSA key pair to send API requests on Binance. Please refer to the document below FAQ .
 	*
 	**How to use the Margin Special Key**
 	* - Use the below `sapi` endpoint to create your margin special API Key.
@@ -3988,7 +4061,7 @@ var RestAPI = class {
 	* - For accessing the Isolated Margin account(s), pass the relevant `symbol` parameter in the API Key creation request.
 	* - Use the generated API Key (and Secret key, if applicable) to perform margin trading and listenKey generation via **Spot** REST API (`https://api.binance.com/api/v3/*`) endpoints.
 	*
-	* Read [REST API](/products/spot/rest-api#signed-trade-and-user_data-endpoint-security) or [WebSocket API](/products/spot/web-socket-api#request-security) documentation to learn how to use different API keys
+	* Read REST API or WebSocket API documentation to learn how to use different API keys
 	*
 	* You need to enable Permits “Enable Spot & Margin Trading” option for the API Key which requests this endpoint.
 	*
@@ -4077,7 +4150,7 @@ var RestAPI = class {
 	* 2. All pre-execution margin checks (including Open-order-loss calculation) will revert to standard mode.
 	* 3. A cooldown period (default: 24 hours) will be enforced, during which the account will not be permitted to create new Margin Special API Keys.
 	*
-	* For more information, please refer to [FAQ](https://www.binance.com/en/support/faq/detail/3208663e900d4d2e9fec4140e1832f4e).
+	* For more information, please refer to FAQ.
 	*
 	**Preconditions:**
 	*
@@ -4306,8 +4379,15 @@ var RestAPI = class {
 	*
 	* Notes:
 	* - autoRepayAtCancel is suggested to set as “FALSE” to keep liability unrepaid under high frequent new order/cancel order execution
-	* - Depending on the `pendingType` or `workingType`, some optional
-	* - parameters will become mandatory: | Type                                                     | Additional mandatory parameters                              | Additional information | | -------------------------------------------------------- | ------------------------------------------------------------ | ---------------------- | | `workingType` = `LIMIT`                                  | `workingTimeInForce`                                         |                        | | `pendingType` = `LIMIT`                                  | `pendingPrice`, `pendingTimeInForce`                         |                        | | `pendingType` = `STOP_LOSS` or `TAKE_PROFIT`             | `pendingStopPrice` and/or `pendingTrailingDelta`             |                        | | `pendingType` = `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` | `pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce` |                        | | `pendingTrailingDelta` is provided | `pendingPrice` |                        |
+	* - Depending on the `pendingType` or `workingType`, some optional parameters will become mandatory:
+	*
+	* | Type | Additional mandatory parameters | Additional information |
+	* | --- | --- | --- |
+	* | `workingType` = `LIMIT` | `workingTimeInForce` | |
+	* | `pendingType` = `LIMIT` | `pendingPrice`, `pendingTimeInForce` | |
+	* | `pendingType` = `STOP_LOSS` or `TAKE_PROFIT` | `pendingStopPrice` and/or `pendingTrailingDelta` | |
+	* | `pendingType` = `STOP_LOSS_LIMIT` or `TAKE_PROFIT_LIMIT` | `pendingPrice`, `pendingStopPrice` and/or `pendingTrailingDelta`, `pendingTimeInForce` | |
+	* | `pendingTrailingDelta` is provided | `pendingPrice` | |
 	*
 	* @summary Margin Account New OTO (TRADE)
 	* @param {MarginAccountNewOtoRequest} requestParameters Request parameters.
@@ -4322,7 +4402,6 @@ var RestAPI = class {
 	/**
 	* Post a new OTOCO order for margin account：
 	*
-	*
 	* - An OTOCO (One-Triggers-One-Cancels-the-Other) is an order list
 	* comprised of 3 orders.
 	*
@@ -4332,7 +4411,7 @@ var RestAPI = class {
 	* - OTOCO has 2 pending orders (pending above and pending below), forming
 	* an OCO pair. The pending orders are only placed on the order book when
 	* the working order gets **fully filled**.
-	* - The rules of the pending above and pending below follow the same rules as the [Order List OCO](https://developers.binance.com/en/docs/catalog/core-trading-margin-trading/api/rest-api/trade#margin-account-new-oco).
+	* - The rules of the pending above and pending below follow the same rules as the Order List OCO.
 	* - OTOCOs add **3 orders** against the unfilled order count,
 	* `EXCHANGE_MAX_NUM_ORDERS` filter, and `MAX_NUM_ORDERS` filter.
 	*
@@ -4535,6 +4614,29 @@ var RestAPI = class {
 		return this.tradeApi.queryMarginAccountsOpenOrders(requestParameters);
 	}
 	/**
+	* Retrieves all open OTO / OTOCO order lists of the margin account.
+	*
+	*
+	* Notes:
+	* - The returned list contains order lists whose `listOrderStatus` is `EXECUTING`, i.e. at least one order of the list is still open (`NEW` / `PARTIALLY_FILLED`).
+	* - For OTO, the `orders` array contains 2 orders: the working order and the pending order.
+	* - For OTOCO, the `orders` array contains 3 orders: the working order and the two pending orders (pending above / pending below).
+	*
+	* Weight(UID): 10
+	*
+	* Security Type: USER_DATA
+	*
+	* @summary Query Margin Account\'s Open OTO/OTOCO Order Lists (USER_DATA)
+	* @param {QueryMarginAccountsOpenOtootocoOrderListsRequest} requestParameters Request parameters.
+	*
+	* @returns {Promise<RestApiResponse<QueryMarginAccountsOpenOtootocoOrderListsResponse>>}
+	* @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
+	* @see {@link https://developers.binance.com/en/docs/catalog/core-trading-margin-trading/api/rest-api/trade#query-margin-accounts-open-otootoco-order-lists Binance API Documentation}
+	*/
+	queryMarginAccountsOpenOtootocoOrderLists(requestParameters = {}) {
+		return this.tradeApi.queryMarginAccountsOpenOtootocoOrderLists(requestParameters);
+	}
+	/**
 	* Query Margin Account's Order
 	*
 	* Weight(IP): 10