binance 2.12.3 → 2.13.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  import { AxiosRequestConfig } from 'axios';
2
2
  import { BasicSymbolPaginatedParams, BasicSymbolParam, GetOrderParams, OrderBookParams, HistoricalTradesParams, KlinesParams, Kline, RecentTradesParams, CancelOrderParams, SymbolFromPaginatedRequestFromId, GetAllOrdersParams, GenericCodeMsgError, SymbolPrice } from './types/shared';
3
- import { ContinuousContractKlinesParams, IndexPriceKlinesParams, SymbolKlinePaginatedParams, FuturesDataPaginatedParams, MultiAssetsMode, NewFuturesOrderParams, CancelMultipleOrdersParams, CancelOrdersTimeoutParams, SetLeverageParams, SetMarginTypeParams, SetIsolatedMarginParams, GetPositionMarginChangeHistoryParams, GetIncomeHistoryParams, GetForceOrdersParams, FuturesExchangeInfo, FuturesOrderBook, RawFuturesTrade, AggregateFuturesTrade, FundingRateHistory, FuturesSymbolOrderBookTicker, OpenInterest, ModeChangeResult, PositionModeParams, PositionModeResponse, MultiAssetModeResponse, NewOrderResult, NewOrderError, OrderResult, CancelFuturesOrderResult, CancelAllOpenOrdersResult, FuturesAccountBalance, FuturesAccountInformation, SetLeverageResult, SetIsolatedMarginResult, FuturesPosition, FuturesPositionTrade, ForceOrderResult, SymbolLeverageBracketsResult, IncomeHistory, RebateDataOverview, SetCancelTimeoutResult, ChangeStats24hr, MarkPrice, HistoricOpenInterest, UserCommissionRate, ModifyFuturesOrderParams, ModifyFuturesOrderResult, QuarterlyContractSettlementPrice, BasisParams, Basis, IndexPriceConstituents, ModifyOrderParams, FuturesTransactionDownloadLink, PortfolioMarginProAccountInfo, GetFuturesOrderModifyHistoryParams, FuturesTradeHistoryDownloadId } from './types/futures';
3
+ import { ContinuousContractKlinesParams, IndexPriceKlinesParams, SymbolKlinePaginatedParams, FuturesDataPaginatedParams, MultiAssetsMode, NewFuturesOrderParams, CancelMultipleOrdersParams, CancelOrdersTimeoutParams, SetLeverageParams, SetMarginTypeParams, SetIsolatedMarginParams, GetPositionMarginChangeHistoryParams, GetIncomeHistoryParams, GetForceOrdersParams, FuturesExchangeInfo, FuturesOrderBook, RawFuturesTrade, AggregateFuturesTrade, FundingRateHistory, FuturesSymbolOrderBookTicker, OpenInterest, ModeChangeResult, PositionModeParams, PositionModeResponse, MultiAssetModeResponse, NewOrderResult, NewOrderError, OrderResult, CancelFuturesOrderResult, CancelAllOpenOrdersResult, FuturesAccountBalance, FuturesAccountInformation, SetLeverageResult, SetIsolatedMarginResult, FuturesPosition, FuturesPositionTrade, ForceOrderResult, SymbolLeverageBracketsResult, IncomeHistory, RebateDataOverview, SetCancelTimeoutResult, ChangeStats24hr, MarkPrice, HistoricOpenInterest, UserCommissionRate, ModifyFuturesOrderParams, ModifyFuturesOrderResult, QuarterlyContractSettlementPrice, BasisParams, Basis, IndexPriceConstituents, ModifyOrderParams, FuturesTransactionDownloadLink, PortfolioMarginProAccountInfo, GetFuturesOrderModifyHistoryParams, FuturesTradeHistoryDownloadId, FuturesAccountConfig, SymbolConfig, UserForceOrder } from './types/futures';
4
4
  import { RestClientOptions } from './util/requestUtils';
5
5
  import BaseRestClient from './util/BaseRestClient';
6
6
  import { FundingRate } from './types/coin';
@@ -13,7 +13,7 @@ export declare class USDMClient extends BaseRestClient {
13
13
  getServerTime(): Promise<number>;
14
14
  /**
15
15
  *
16
- * Market Data Endpoints
16
+ * MARKET DATA endpoints - Rest API
17
17
  *
18
18
  **/
19
19
  testConnectivity(): Promise<{}>;
@@ -22,15 +22,15 @@ export declare class USDMClient extends BaseRestClient {
22
22
  getRecentTrades(params: RecentTradesParams): Promise<RawFuturesTrade[]>;
23
23
  getHistoricalTrades(params: HistoricalTradesParams): Promise<RawFuturesTrade[]>;
24
24
  getAggregateTrades(params: SymbolFromPaginatedRequestFromId): Promise<AggregateFuturesTrade[]>;
25
- getMarkPrice(params: BasicSymbolParam): Promise<MarkPrice>;
26
- getMarkPrice(): Promise<MarkPrice[]>;
27
- getFundingRateHistory(params?: Partial<BasicSymbolPaginatedParams>): Promise<FundingRateHistory[]>;
28
- getFundingRates(): Promise<FundingRate[]>;
29
25
  getKlines(params: KlinesParams): Promise<Kline[]>;
30
26
  getContinuousContractKlines(params: ContinuousContractKlinesParams): Promise<Kline[]>;
31
27
  getIndexPriceKlines(params: IndexPriceKlinesParams): Promise<Kline[]>;
32
28
  getMarkPriceKlines(params: SymbolKlinePaginatedParams): Promise<Kline[]>;
33
29
  getPremiumIndexKlines(params: SymbolKlinePaginatedParams): Promise<Kline[]>;
30
+ getMarkPrice(params: BasicSymbolParam): Promise<MarkPrice>;
31
+ getMarkPrice(): Promise<MarkPrice[]>;
32
+ getFundingRateHistory(params?: Partial<BasicSymbolPaginatedParams>): Promise<FundingRateHistory[]>;
33
+ getFundingRates(): Promise<FundingRate[]>;
34
34
  /**
35
35
  * @deprecated use get24hrChangeStatistics() instead (method without the typo)
36
36
  */
@@ -41,85 +41,108 @@ export declare class USDMClient extends BaseRestClient {
41
41
  getSymbolPriceTicker(params?: Partial<BasicSymbolParam>): Promise<SymbolPrice | SymbolPrice[]>;
42
42
  getSymbolPriceTickerV2(params?: Partial<BasicSymbolParam>): Promise<SymbolPrice | SymbolPrice[]>;
43
43
  getSymbolOrderBookTicker(params?: Partial<BasicSymbolParam>): Promise<FuturesSymbolOrderBookTicker | FuturesSymbolOrderBookTicker[]>;
44
+ getQuarterlyContractSettlementPrices(params: {
45
+ pair: string;
46
+ }): Promise<QuarterlyContractSettlementPrice[]>;
44
47
  getOpenInterest(params: BasicSymbolParam): Promise<OpenInterest>;
45
48
  getOpenInterestStatistics(params: FuturesDataPaginatedParams): Promise<HistoricOpenInterest[]>;
46
- getTopTradersLongShortAccountRatio(params: FuturesDataPaginatedParams): Promise<any>;
47
49
  getTopTradersLongShortPositionRatio(params: FuturesDataPaginatedParams): Promise<any>;
50
+ getTopTradersLongShortAccountRatio(params: FuturesDataPaginatedParams): Promise<any>;
48
51
  getGlobalLongShortAccountRatio(params: FuturesDataPaginatedParams): Promise<any>;
49
52
  getTakerBuySellVolume(params: FuturesDataPaginatedParams): Promise<any>;
50
53
  getHistoricalBlvtNavKlines(params: SymbolKlinePaginatedParams): Promise<any>;
51
54
  getCompositeSymbolIndex(params?: Partial<BasicSymbolParam>): Promise<any>;
52
- getQuarterlyContractSettlementPrices(params: {
53
- pair: string;
54
- }): Promise<QuarterlyContractSettlementPrice[]>;
55
- getBasis(params: BasisParams): Promise<Basis[]>;
56
55
  getMultiAssetsModeAssetIndex(params?: {
57
56
  symbol?: string;
58
57
  }): Promise<any>;
58
+ /**
59
+ * Possibly @deprecated, found only in old docs
60
+ **/
61
+ getBasis(params: BasisParams): Promise<Basis[]>;
62
+ /**
63
+ * Possibly @deprecated, found only in old docs
64
+ **/
59
65
  getIndexPriceConstituents(params: {
60
66
  symbol: string;
61
67
  }): Promise<IndexPriceConstituents>;
62
68
  /**
63
69
  *
64
- * USD-Futures Account/Trade Endpoints
70
+ * TRADE endpoints - Rest API
65
71
  *
66
72
  **/
67
- setPositionMode(params: PositionModeParams): Promise<ModeChangeResult>;
68
- getCurrentPositionMode(): Promise<PositionModeResponse>;
69
- setMultiAssetsMode(params: {
70
- multiAssetsMargin: MultiAssetsMode;
71
- }): Promise<ModeChangeResult>;
72
- getMultiAssetsMode(): Promise<MultiAssetModeResponse>;
73
- setBNBBurnEnabled(params: {
74
- feeBurn: 'true' | 'false';
75
- }): Promise<{
76
- code: number;
77
- msg: string;
78
- }>;
79
- getBNBBurnStatus(): Promise<{
80
- feeBurn: boolean;
81
- }>;
82
73
  submitNewOrder(params: NewFuturesOrderParams): Promise<NewOrderResult>;
83
- testOrder(params: NewFuturesOrderParams): Promise<any>;
84
- /**
85
- * Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue
86
- */
87
- modifyOrder(params: ModifyFuturesOrderParams): Promise<ModifyFuturesOrderResult>;
88
- modifyMultipleOrders(orders: ModifyOrderParams[]): Promise<any>;
89
- getOrderModifyHistory(params: GetFuturesOrderModifyHistoryParams): Promise<any>;
90
74
  /**
91
75
  * Warning: max 5 orders at a time! This method does not throw, instead it returns individual errors in the response array if any orders were rejected.
92
76
  *
93
77
  * Known issue: `quantity` and `price` should be sent as strings
94
78
  */
95
79
  submitMultipleOrders(orders: NewFuturesOrderParams<string>[]): Promise<(NewOrderResult | NewOrderError)[]>;
96
- getOrder(params: GetOrderParams): Promise<OrderResult>;
80
+ /**
81
+ * Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue
82
+ */
83
+ modifyOrder(params: ModifyFuturesOrderParams): Promise<ModifyFuturesOrderResult>;
84
+ modifyMultipleOrders(orders: ModifyOrderParams[]): Promise<any>;
85
+ getOrderModifyHistory(params: GetFuturesOrderModifyHistoryParams): Promise<any>;
97
86
  cancelOrder(params: CancelOrderParams): Promise<CancelFuturesOrderResult>;
98
- cancelAllOpenOrders(params: BasicSymbolParam): Promise<CancelAllOpenOrdersResult>;
99
87
  cancelMultipleOrders(params: CancelMultipleOrdersParams): Promise<(CancelFuturesOrderResult | GenericCodeMsgError)[]>;
88
+ cancelAllOpenOrders(params: BasicSymbolParam): Promise<CancelAllOpenOrdersResult>;
100
89
  setCancelOrdersOnTimeout(params: CancelOrdersTimeoutParams): Promise<SetCancelTimeoutResult>;
101
- getCurrentOpenOrder(params: GetOrderParams): Promise<OrderResult>;
102
- getAllOpenOrders(params?: Partial<BasicSymbolParam>): Promise<OrderResult[]>;
90
+ getOrder(params: GetOrderParams): Promise<OrderResult>;
103
91
  getAllOrders(params: GetAllOrdersParams): Promise<OrderResult[]>;
104
- getBalance(): Promise<FuturesAccountBalance[]>;
105
- getAccountInformation(): Promise<FuturesAccountInformation>;
106
- setLeverage(params: SetLeverageParams): Promise<SetLeverageResult>;
107
- setMarginType(params: SetMarginTypeParams): Promise<ModeChangeResult>;
108
- setIsolatedPositionMargin(params: SetIsolatedMarginParams): Promise<SetIsolatedMarginResult>;
109
- getPositionMarginChangeHistory(params: GetPositionMarginChangeHistoryParams): Promise<any>;
110
- getPositions(params?: Partial<BasicSymbolParam>): Promise<FuturesPosition[]>;
92
+ getAllOpenOrders(params?: Partial<BasicSymbolParam>): Promise<OrderResult[]>;
93
+ getCurrentOpenOrder(params: GetOrderParams): Promise<OrderResult>;
94
+ getForceOrders(params?: GetForceOrdersParams): Promise<ForceOrderResult[]>;
111
95
  getAccountTrades(params: SymbolFromPaginatedRequestFromId & {
112
96
  orderId?: number;
113
97
  }): Promise<FuturesPositionTrade[]>;
114
- getIncomeHistory(params?: GetIncomeHistoryParams): Promise<IncomeHistory[]>;
98
+ setMarginType(params: SetMarginTypeParams): Promise<ModeChangeResult>;
99
+ setPositionMode(params: PositionModeParams): Promise<ModeChangeResult>;
100
+ setLeverage(params: SetLeverageParams): Promise<SetLeverageResult>;
101
+ setMultiAssetsMode(params: {
102
+ multiAssetsMargin: MultiAssetsMode;
103
+ }): Promise<ModeChangeResult>;
104
+ setIsolatedPositionMargin(params: SetIsolatedMarginParams): Promise<SetIsolatedMarginResult>;
105
+ /**
106
+ * @deprecated
107
+ * Use getPositionsV3() instead
108
+ **/
109
+ getPositions(params?: Partial<BasicSymbolParam>): Promise<FuturesPosition[]>;
110
+ getPositionsV3(params?: {
111
+ symbol?: string;
112
+ }): Promise<FuturesPosition[]>;
113
+ getADLQuantileEstimation(params?: Partial<BasicSymbolParam>): Promise<any>;
114
+ getPositionMarginChangeHistory(params: GetPositionMarginChangeHistoryParams): Promise<any>;
115
+ /**
116
+ *
117
+ * ACCOUNT endpoints - Rest API
118
+ *
119
+ **/
120
+ getBalanceV3(): Promise<FuturesAccountBalance[]>;
121
+ /**
122
+ * @deprecated
123
+ * Use getBalanceV3() instead
124
+ **/
125
+ getBalance(): Promise<FuturesAccountBalance[]>;
126
+ getAccountInformationV3(): Promise<FuturesAccountInformation>;
127
+ /**
128
+ * @deprecated
129
+ * Use getAccountInformationV3() instead
130
+ **/
131
+ getAccountInformation(): Promise<FuturesAccountInformation>;
132
+ getAccountComissionRate(params: BasicSymbolParam): Promise<UserCommissionRate>;
133
+ getFuturesAccountConfig(): Promise<FuturesAccountConfig>;
134
+ getFuturesSymbolConfig(params: {
135
+ symbol?: string;
136
+ }): Promise<SymbolConfig[]>;
137
+ getUserForceOrders(): Promise<UserForceOrder[]>;
115
138
  /**
116
139
  * Contrary to what the docs say - if symbol is provided, this returns an array with length 1 (assuming the symbol exists)
117
140
  */
118
141
  getNotionalAndLeverageBrackets(params?: Partial<BasicSymbolParam>): Promise<SymbolLeverageBracketsResult[]>;
119
- getADLQuantileEstimation(params?: Partial<BasicSymbolParam>): Promise<any>;
120
- getForceOrders(params?: GetForceOrdersParams): Promise<ForceOrderResult[]>;
142
+ getMultiAssetsMode(): Promise<MultiAssetModeResponse>;
143
+ getCurrentPositionMode(): Promise<PositionModeResponse>;
144
+ getIncomeHistory(params?: GetIncomeHistoryParams): Promise<IncomeHistory[]>;
121
145
  getApiQuantitativeRulesIndicators(params?: Partial<BasicSymbolParam>): Promise<any>;
122
- getAccountComissionRate(params: BasicSymbolParam): Promise<UserCommissionRate>;
123
146
  getFuturesTransactionHistoryDownloadId(params: {
124
147
  startTime: number;
125
148
  endTime: number;
@@ -141,6 +164,16 @@ export declare class USDMClient extends BaseRestClient {
141
164
  getFuturesTradeDownloadLink(params: {
142
165
  downloadId: string;
143
166
  }): Promise<FuturesTransactionDownloadLink>;
167
+ setBNBBurnEnabled(params: {
168
+ feeBurn: 'true' | 'false';
169
+ }): Promise<{
170
+ code: number;
171
+ msg: string;
172
+ }>;
173
+ getBNBBurnStatus(): Promise<{
174
+ feeBurn: boolean;
175
+ }>;
176
+ testOrder(params: NewFuturesOrderParams): Promise<any>;
144
177
  /**
145
178
  *
146
179
  * Portfolio Margin Pro Endpoints
@@ -152,22 +185,48 @@ export declare class USDMClient extends BaseRestClient {
152
185
  /**
153
186
  *
154
187
  * Broker Futures Endpoints
188
+ * Possibly @deprecated, found only in old docs
189
+ * All broker endpoints start with /sapi/v1/broker or sapi/v2/broker or sapi/v3/broker
155
190
  *
156
191
  **/
192
+ /**
193
+ * @deprecated
194
+ **/
157
195
  getBrokerIfNewFuturesUser(brokerId: string, type?: 1 | 2): Promise<{
158
196
  brokerId: string;
159
197
  rebateWorking: boolean;
160
198
  ifNewUser: boolean;
161
199
  }>;
200
+ /**
201
+ * @deprecated
202
+ **/
162
203
  setBrokerCustomIdForClient(customerId: string, email: string): Promise<{
163
204
  customerId: string;
164
205
  email: string;
165
206
  }>;
207
+ /**
208
+ * @deprecated
209
+ **/
166
210
  getBrokerClientCustomIds(customerId: string, email: string, page?: number, limit?: number): Promise<any>;
211
+ /**
212
+ * @deprecated
213
+ **/
167
214
  getBrokerUserCustomId(brokerId: string): Promise<any>;
215
+ /**
216
+ * @deprecated
217
+ **/
168
218
  getBrokerRebateDataOverview(type?: 1 | 2): Promise<RebateDataOverview>;
219
+ /**
220
+ * @deprecated
221
+ **/
169
222
  getBrokerUserTradeVolume(type?: 1 | 2, startTime?: number, endTime?: number, limit?: number): Promise<any>;
223
+ /**
224
+ * @deprecated
225
+ **/
170
226
  getBrokerRebateVolume(type?: 1 | 2, startTime?: number, endTime?: number, limit?: number): Promise<any>;
227
+ /**
228
+ * @deprecated
229
+ **/
171
230
  getBrokerTradeDetail(type?: 1 | 2, startTime?: number, endTime?: number, limit?: number): Promise<any>;
172
231
  /**
173
232
  *
@@ -32,7 +32,7 @@ class USDMClient extends BaseRestClient_1.default {
32
32
  }
33
33
  /**
34
34
  *
35
- * Market Data Endpoints
35
+ * MARKET DATA endpoints - Rest API
36
36
  *
37
37
  **/
38
38
  testConnectivity() {
@@ -53,18 +53,6 @@ class USDMClient extends BaseRestClient_1.default {
53
53
  getAggregateTrades(params) {
54
54
  return this.get('fapi/v1/aggTrades', params);
55
55
  }
56
- /**
57
- * Index Price and Mark Price
58
- */
59
- getMarkPrice(params) {
60
- return this.get('fapi/v1/premiumIndex', params);
61
- }
62
- getFundingRateHistory(params) {
63
- return this.get('fapi/v1/fundingRate', params);
64
- }
65
- getFundingRates() {
66
- return this.get('fapi/v1/fundingInfo');
67
- }
68
56
  getKlines(params) {
69
57
  return this.get('fapi/v1/klines', params);
70
58
  }
@@ -80,6 +68,15 @@ class USDMClient extends BaseRestClient_1.default {
80
68
  getPremiumIndexKlines(params) {
81
69
  return this.get('fapi/v1/premiumIndexKlines', params);
82
70
  }
71
+ getMarkPrice(params) {
72
+ return this.get('fapi/v1/premiumIndex', params);
73
+ }
74
+ getFundingRateHistory(params) {
75
+ return this.get('fapi/v1/fundingRate', params);
76
+ }
77
+ getFundingRates() {
78
+ return this.get('fapi/v1/fundingInfo');
79
+ }
83
80
  /**
84
81
  * @deprecated use get24hrChangeStatistics() instead (method without the typo)
85
82
  */
@@ -98,18 +95,21 @@ class USDMClient extends BaseRestClient_1.default {
98
95
  getSymbolOrderBookTicker(params) {
99
96
  return this.get('fapi/v1/ticker/bookTicker', params);
100
97
  }
98
+ getQuarterlyContractSettlementPrices(params) {
99
+ return this.get('futures/data/delivery-price', params);
100
+ }
101
101
  getOpenInterest(params) {
102
102
  return this.get('fapi/v1/openInterest', params);
103
103
  }
104
104
  getOpenInterestStatistics(params) {
105
105
  return this.get('futures/data/openInterestHist', params);
106
106
  }
107
- getTopTradersLongShortAccountRatio(params) {
108
- return this.get('futures/data/topLongShortAccountRatio', params);
109
- }
110
107
  getTopTradersLongShortPositionRatio(params) {
111
108
  return this.get('futures/data/topLongShortPositionRatio', params);
112
109
  }
110
+ getTopTradersLongShortAccountRatio(params) {
111
+ return this.get('futures/data/topLongShortAccountRatio', params);
112
+ }
113
113
  getGlobalLongShortAccountRatio(params) {
114
114
  return this.get('futures/data/globalLongShortAccountRatio', params);
115
115
  }
@@ -122,65 +122,30 @@ class USDMClient extends BaseRestClient_1.default {
122
122
  getCompositeSymbolIndex(params) {
123
123
  return this.get('fapi/v1/indexInfo', params);
124
124
  }
125
- getQuarterlyContractSettlementPrices(params) {
126
- return this.get('futures/data/delivery-price', params);
125
+ getMultiAssetsModeAssetIndex(params) {
126
+ return this.get('fapi/v1/assetIndex', params);
127
127
  }
128
+ /**
129
+ * Possibly @deprecated, found only in old docs
130
+ **/
128
131
  getBasis(params) {
129
132
  return this.get('futures/data/basis', params);
130
133
  }
131
- getMultiAssetsModeAssetIndex(params) {
132
- return this.get('fapi/v1/assetIndex', params);
133
- }
134
+ /**
135
+ * Possibly @deprecated, found only in old docs
136
+ **/
134
137
  getIndexPriceConstituents(params) {
135
138
  return this.get('fapi/v1/constituents', params);
136
139
  }
137
140
  /**
138
141
  *
139
- * USD-Futures Account/Trade Endpoints
142
+ * TRADE endpoints - Rest API
140
143
  *
141
144
  **/
142
- setPositionMode(params) {
143
- return this.postPrivate('fapi/v1/positionSide/dual', params);
144
- }
145
- getCurrentPositionMode() {
146
- return this.getPrivate('fapi/v1/positionSide/dual');
147
- }
148
- setMultiAssetsMode(params) {
149
- return this.postPrivate('fapi/v1/multiAssetsMargin', params);
150
- }
151
- getMultiAssetsMode() {
152
- return this.getPrivate('fapi/v1/multiAssetsMargin');
153
- }
154
- setBNBBurnEnabled(params) {
155
- return this.postPrivate('fapi/v1/feeBurn', params);
156
- }
157
- getBNBBurnStatus() {
158
- return this.getPrivate('fapi/v1/feeBurn');
159
- }
160
145
  submitNewOrder(params) {
161
146
  this.validateOrderId(params, 'newClientOrderId');
162
147
  return this.postPrivate('fapi/v1/order', params);
163
148
  }
164
- testOrder(params) {
165
- this.validateOrderId(params, 'newClientOrderId');
166
- return this.postPrivate('fapi/v1/order/test', params);
167
- }
168
- /**
169
- * Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue
170
- */
171
- modifyOrder(params) {
172
- return this.putPrivate('fapi/v1/order', params);
173
- }
174
- modifyMultipleOrders(orders) {
175
- const stringOrders = orders.map((order) => JSON.stringify(order));
176
- const requestBody = {
177
- batchOrders: `[${stringOrders.join(',')}]`,
178
- };
179
- return this.putPrivate('fapi/v1/batchOrders', requestBody);
180
- }
181
- getOrderModifyHistory(params) {
182
- return this.getPrivate('fapi/v1/orderAmendment', params);
183
- }
184
149
  /**
185
150
  * Warning: max 5 orders at a time! This method does not throw, instead it returns individual errors in the response array if any orders were rejected.
186
151
  *
@@ -197,15 +162,25 @@ class USDMClient extends BaseRestClient_1.default {
197
162
  };
198
163
  return this.postPrivate('fapi/v1/batchOrders', requestBody);
199
164
  }
200
- getOrder(params) {
201
- return this.getPrivate('fapi/v1/order', params);
165
+ /**
166
+ * Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue
167
+ */
168
+ modifyOrder(params) {
169
+ return this.putPrivate('fapi/v1/order', params);
170
+ }
171
+ modifyMultipleOrders(orders) {
172
+ const stringOrders = orders.map((order) => JSON.stringify(order));
173
+ const requestBody = {
174
+ batchOrders: `[${stringOrders.join(',')}]`,
175
+ };
176
+ return this.putPrivate('fapi/v1/batchOrders', requestBody);
177
+ }
178
+ getOrderModifyHistory(params) {
179
+ return this.getPrivate('fapi/v1/orderAmendment', params);
202
180
  }
203
181
  cancelOrder(params) {
204
182
  return this.deletePrivate('fapi/v1/order', params);
205
183
  }
206
- cancelAllOpenOrders(params) {
207
- return this.deletePrivate('fapi/v1/allOpenOrders', params);
208
- }
209
184
  cancelMultipleOrders(params) {
210
185
  const requestParams = Object.assign({}, params);
211
186
  if (params.orderIdList) {
@@ -216,45 +191,98 @@ class USDMClient extends BaseRestClient_1.default {
216
191
  }
217
192
  return this.deletePrivate('fapi/v1/batchOrders', requestParams);
218
193
  }
194
+ cancelAllOpenOrders(params) {
195
+ return this.deletePrivate('fapi/v1/allOpenOrders', params);
196
+ }
219
197
  // Auto-cancel all open orders
220
198
  setCancelOrdersOnTimeout(params) {
221
199
  return this.postPrivate('fapi/v1/countdownCancelAll', params);
222
200
  }
223
- getCurrentOpenOrder(params) {
224
- return this.getPrivate('fapi/v1/openOrder', params);
201
+ getOrder(params) {
202
+ return this.getPrivate('fapi/v1/order', params);
203
+ }
204
+ getAllOrders(params) {
205
+ return this.getPrivate('fapi/v1/allOrders', params);
225
206
  }
226
207
  getAllOpenOrders(params) {
227
208
  return this.getPrivate('fapi/v1/openOrders', params);
228
209
  }
229
- getAllOrders(params) {
230
- return this.getPrivate('fapi/v1/allOrders', params);
210
+ getCurrentOpenOrder(params) {
211
+ return this.getPrivate('fapi/v1/openOrder', params);
231
212
  }
232
- getBalance() {
233
- return this.getPrivate('fapi/v2/balance');
213
+ getForceOrders(params) {
214
+ return this.getPrivate('fapi/v1/forceOrders', params);
234
215
  }
235
- getAccountInformation() {
236
- return this.getPrivate('fapi/v2/account');
216
+ getAccountTrades(params) {
217
+ return this.getPrivate('fapi/v1/userTrades', params);
218
+ }
219
+ setMarginType(params) {
220
+ return this.postPrivate('fapi/v1/marginType', params);
221
+ }
222
+ setPositionMode(params) {
223
+ return this.postPrivate('fapi/v1/positionSide/dual', params);
237
224
  }
238
225
  setLeverage(params) {
239
226
  return this.postPrivate('fapi/v1/leverage', params);
240
227
  }
241
- setMarginType(params) {
242
- return this.postPrivate('fapi/v1/marginType', params);
228
+ setMultiAssetsMode(params) {
229
+ return this.postPrivate('fapi/v1/multiAssetsMargin', params);
243
230
  }
244
231
  setIsolatedPositionMargin(params) {
245
232
  return this.postPrivate('fapi/v1/positionMargin', params);
246
233
  }
234
+ /**
235
+ * @deprecated
236
+ * Use getPositionsV3() instead
237
+ **/
238
+ getPositions(params) {
239
+ return this.getPrivate('fapi/v2/positionRisk', params);
240
+ }
241
+ getPositionsV3(params) {
242
+ return this.getPrivate('fapi/v3/positionRisk', params);
243
+ }
244
+ getADLQuantileEstimation(params) {
245
+ return this.getPrivate('fapi/v1/adlQuantile', params);
246
+ }
247
247
  getPositionMarginChangeHistory(params) {
248
248
  return this.getPrivate('fapi/v1/positionMargin/history', params);
249
249
  }
250
- getPositions(params) {
251
- return this.getPrivate('fapi/v2/positionRisk', params);
250
+ /**
251
+ *
252
+ * ACCOUNT endpoints - Rest API
253
+ *
254
+ **/
255
+ getBalanceV3() {
256
+ return this.getPrivate('fapi/v3/balance');
252
257
  }
253
- getAccountTrades(params) {
254
- return this.getPrivate('fapi/v1/userTrades', params);
258
+ /**
259
+ * @deprecated
260
+ * Use getBalanceV3() instead
261
+ **/
262
+ getBalance() {
263
+ return this.getPrivate('fapi/v2/balance');
255
264
  }
256
- getIncomeHistory(params) {
257
- return this.getPrivate('fapi/v1/income', params);
265
+ getAccountInformationV3() {
266
+ return this.getPrivate('fapi/v3/account');
267
+ }
268
+ /**
269
+ * @deprecated
270
+ * Use getAccountInformationV3() instead
271
+ **/
272
+ getAccountInformation() {
273
+ return this.getPrivate('fapi/v2/account');
274
+ }
275
+ getAccountComissionRate(params) {
276
+ return this.getPrivate('fapi/v1/commissionRate', params);
277
+ }
278
+ getFuturesAccountConfig() {
279
+ return this.getPrivate('fapi/v1/accountConfig');
280
+ }
281
+ getFuturesSymbolConfig(params) {
282
+ return this.getPrivate('fapi/v1/symbolConfig', params);
283
+ }
284
+ getUserForceOrders() {
285
+ return this.getPrivate('fapi/v1/rateLimit/order');
258
286
  }
259
287
  /**
260
288
  * Contrary to what the docs say - if symbol is provided, this returns an array with length 1 (assuming the symbol exists)
@@ -262,18 +290,18 @@ class USDMClient extends BaseRestClient_1.default {
262
290
  getNotionalAndLeverageBrackets(params) {
263
291
  return this.getPrivate('fapi/v1/leverageBracket', params);
264
292
  }
265
- getADLQuantileEstimation(params) {
266
- return this.getPrivate('fapi/v1/adlQuantile', params);
293
+ getMultiAssetsMode() {
294
+ return this.getPrivate('fapi/v1/multiAssetsMargin');
267
295
  }
268
- getForceOrders(params) {
269
- return this.getPrivate('fapi/v1/forceOrders', params);
296
+ getCurrentPositionMode() {
297
+ return this.getPrivate('fapi/v1/positionSide/dual');
298
+ }
299
+ getIncomeHistory(params) {
300
+ return this.getPrivate('fapi/v1/income', params);
270
301
  }
271
302
  getApiQuantitativeRulesIndicators(params) {
272
303
  return this.getPrivate('fapi/v1/apiTradingStatus', params);
273
304
  }
274
- getAccountComissionRate(params) {
275
- return this.getPrivate('fapi/v1/commissionRate', params);
276
- }
277
305
  getFuturesTransactionHistoryDownloadId(params) {
278
306
  return this.getPrivate('fapi/v1/income/asyn', params);
279
307
  }
@@ -292,6 +320,16 @@ class USDMClient extends BaseRestClient_1.default {
292
320
  getFuturesTradeDownloadLink(params) {
293
321
  return this.getPrivate('fapi/v1/trade/asyn/id', params);
294
322
  }
323
+ setBNBBurnEnabled(params) {
324
+ return this.postPrivate('fapi/v1/feeBurn', params);
325
+ }
326
+ getBNBBurnStatus() {
327
+ return this.getPrivate('fapi/v1/feeBurn');
328
+ }
329
+ testOrder(params) {
330
+ this.validateOrderId(params, 'newClientOrderId');
331
+ return this.postPrivate('fapi/v1/order/test', params);
332
+ }
295
333
  /**
296
334
  *
297
335
  * Portfolio Margin Pro Endpoints
@@ -303,21 +341,31 @@ class USDMClient extends BaseRestClient_1.default {
303
341
  /**
304
342
  *
305
343
  * Broker Futures Endpoints
344
+ * Possibly @deprecated, found only in old docs
345
+ * All broker endpoints start with /sapi/v1/broker or sapi/v2/broker or sapi/v3/broker
306
346
  *
307
347
  **/
308
- // 1 == USDT-Margined, 2 == Coin-margined
348
+ /**
349
+ * @deprecated
350
+ **/
309
351
  getBrokerIfNewFuturesUser(brokerId, type = 1) {
310
352
  return this.getPrivate('fapi/v1/apiReferral/ifNewUser', {
311
353
  brokerId,
312
354
  type,
313
355
  });
314
356
  }
357
+ /**
358
+ * @deprecated
359
+ **/
315
360
  setBrokerCustomIdForClient(customerId, email) {
316
361
  return this.postPrivate('fapi/v1/apiReferral/customization', {
317
362
  customerId,
318
363
  email,
319
364
  });
320
365
  }
366
+ /**
367
+ * @deprecated
368
+ **/
321
369
  getBrokerClientCustomIds(customerId, email, page, limit) {
322
370
  return this.getPrivate('fapi/v1/apiReferral/customization', {
323
371
  customerId,
@@ -326,16 +374,25 @@ class USDMClient extends BaseRestClient_1.default {
326
374
  limit,
327
375
  });
328
376
  }
377
+ /**
378
+ * @deprecated
379
+ **/
329
380
  getBrokerUserCustomId(brokerId) {
330
381
  return this.getPrivate('fapi/v1/apiReferral/userCustomization', {
331
382
  brokerId,
332
383
  });
333
384
  }
385
+ /**
386
+ * @deprecated
387
+ **/
334
388
  getBrokerRebateDataOverview(type = 1) {
335
389
  return this.getPrivate('fapi/v1/apiReferral/overview', {
336
390
  type,
337
391
  });
338
392
  }
393
+ /**
394
+ * @deprecated
395
+ **/
339
396
  getBrokerUserTradeVolume(type = 1, startTime, endTime, limit) {
340
397
  return this.getPrivate('fapi/v1/apiReferral/tradeVol', {
341
398
  type,
@@ -344,6 +401,9 @@ class USDMClient extends BaseRestClient_1.default {
344
401
  limit,
345
402
  });
346
403
  }
404
+ /**
405
+ * @deprecated
406
+ **/
347
407
  getBrokerRebateVolume(type = 1, startTime, endTime, limit) {
348
408
  return this.getPrivate('fapi/v1/apiReferral/rebateVol', {
349
409
  type,
@@ -352,6 +412,9 @@ class USDMClient extends BaseRestClient_1.default {
352
412
  limit,
353
413
  });
354
414
  }
415
+ /**
416
+ * @deprecated
417
+ **/
355
418
  getBrokerTradeDetail(type = 1, startTime, endTime, limit) {
356
419
  return this.getPrivate('fapi/v1/apiReferral/traderSummary', {
357
420
  type,