kucoin-api 1.0.22 → 2.0.0
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.
- package/README.md +3 -3
- package/dist/cjs/FuturesClient.d.ts +302 -96
- package/dist/cjs/FuturesClient.js +289 -96
- package/dist/cjs/FuturesClient.js.map +1 -1
- package/dist/cjs/SpotClient.d.ts +899 -234
- package/dist/cjs/SpotClient.js +962 -320
- package/dist/cjs/SpotClient.js.map +1 -1
- package/dist/mjs/FuturesClient.d.ts +302 -96
- package/dist/mjs/FuturesClient.js +289 -96
- package/dist/mjs/FuturesClient.js.map +1 -1
- package/dist/mjs/SpotClient.d.ts +899 -234
- package/dist/mjs/SpotClient.js +962 -320
- package/dist/mjs/SpotClient.js.map +1 -1
- package/package.json +1 -1
|
@@ -20,249 +20,412 @@ export class FuturesClient extends BaseRestClient {
|
|
|
20
20
|
generateNewOrderID() {
|
|
21
21
|
return nanoid(32);
|
|
22
22
|
}
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* REST - ACCOUNT INFO - Account & Funding
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
/**
|
|
29
|
+
* Get Account - Futures
|
|
30
|
+
* Request via this endpoint to get the info of the futures account.
|
|
31
|
+
*/
|
|
32
|
+
getBalance(params) {
|
|
33
|
+
return this.getPrivate('api/v1/account-overview', params);
|
|
28
34
|
}
|
|
29
35
|
/**
|
|
30
|
-
* REST - ACCOUNT - BASIC INFO
|
|
31
36
|
* Get Account Ledgers - Futures
|
|
37
|
+
* This interface can query the ledger records of the futures business line
|
|
32
38
|
*/
|
|
33
39
|
getTransactions(params) {
|
|
34
40
|
return this.getPrivate('api/v1/transaction-history', params);
|
|
35
41
|
}
|
|
36
42
|
/**
|
|
37
|
-
*
|
|
43
|
+
*
|
|
44
|
+
* REST - ACCOUNT INFO - Sub Account
|
|
45
|
+
*
|
|
38
46
|
*/
|
|
39
|
-
getSubAPIs(params) {
|
|
40
|
-
return this.getPrivate('api/v1/sub/api-key', params);
|
|
41
|
-
}
|
|
42
|
-
createSubAPI(params) {
|
|
43
|
-
return this.postPrivate('api/v1/sub/api-key', params);
|
|
44
|
-
}
|
|
45
|
-
updateSubAPI(params) {
|
|
46
|
-
return this.postPrivate('api/v1/sub/api-key/update', params);
|
|
47
|
-
}
|
|
48
|
-
deleteSubAPI(params) {
|
|
49
|
-
return this.deletePrivate('api/v1/sub/api-key', params);
|
|
50
|
-
}
|
|
51
47
|
/**
|
|
52
|
-
*
|
|
48
|
+
* Get SubAccount List - Futures Balance(V2)
|
|
49
|
+
* This endpoint can be used to get Futures sub-account information.
|
|
53
50
|
*/
|
|
54
|
-
getBalance(params) {
|
|
55
|
-
return this.getPrivate('api/v1/account-overview', params);
|
|
56
|
-
}
|
|
57
51
|
getSubBalances(params) {
|
|
58
52
|
return this.getPrivate('api/v1/account-overview-all', params);
|
|
59
53
|
}
|
|
60
54
|
/**
|
|
61
|
-
*
|
|
55
|
+
*
|
|
56
|
+
* REST - Account Info - Trade Fee
|
|
57
|
+
*
|
|
62
58
|
*/
|
|
63
|
-
submitTransferOut(params) {
|
|
64
|
-
return this.postPrivate('api/v3/transfer-out', params);
|
|
65
|
-
}
|
|
66
|
-
submitTransferIn(params) {
|
|
67
|
-
return this.postPrivate('api/v1/transfer-in', params);
|
|
68
|
-
}
|
|
69
|
-
getTransfers(params) {
|
|
70
|
-
return this.getPrivate('api/v1/transfer-list', params);
|
|
71
|
-
}
|
|
72
59
|
/**
|
|
73
|
-
*
|
|
60
|
+
* Get Actual Fee - Futures
|
|
61
|
+
* This interface is for the actual futures fee rate of the trading pair. The fee rate of your sub-account is the same as that of the master account.
|
|
74
62
|
*/
|
|
75
63
|
getTradingPairFee(params) {
|
|
76
64
|
return this.getPrivate('api/v1/trade-fees', params);
|
|
77
65
|
}
|
|
78
66
|
/**
|
|
79
67
|
*
|
|
80
|
-
* REST -
|
|
68
|
+
* REST - Futures Trading - Market Data
|
|
81
69
|
*
|
|
82
70
|
*/
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
71
|
+
/**
|
|
72
|
+
* Get Symbol
|
|
73
|
+
* Get information of specified contracts that can be traded.
|
|
74
|
+
* This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.
|
|
75
|
+
*/
|
|
86
76
|
getSymbol(params) {
|
|
87
77
|
return this.get(`api/v1/contracts/${params.symbol}`);
|
|
88
78
|
}
|
|
79
|
+
/**
|
|
80
|
+
* Get Symbol
|
|
81
|
+
* Get information of specified contracts that can be traded.
|
|
82
|
+
* This API will return a list of tradable contracts, including some key parameters of the contract such as the symbol name, tick size, mark price,etc.
|
|
83
|
+
*/
|
|
84
|
+
getSymbols() {
|
|
85
|
+
return this.get('api/v1/contracts/active');
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Get Ticker
|
|
89
|
+
* This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of a single symbol.
|
|
90
|
+
*/
|
|
89
91
|
getTicker(params) {
|
|
90
92
|
return this.get('api/v1/ticker', params);
|
|
91
93
|
}
|
|
94
|
+
/**
|
|
95
|
+
* Get All Tickers
|
|
96
|
+
* This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of all symbol.
|
|
97
|
+
*/
|
|
92
98
|
getTickers() {
|
|
93
99
|
return this.get('api/v1/allTickers');
|
|
94
100
|
}
|
|
101
|
+
/**
|
|
102
|
+
* Get Full OrderBook
|
|
103
|
+
* Query for Full orderbook depth data. (aggregated by price)
|
|
104
|
+
*/
|
|
95
105
|
getFullOrderBookLevel2(params) {
|
|
96
106
|
return this.get('api/v1/level2/snapshot', params);
|
|
97
107
|
}
|
|
108
|
+
/**
|
|
109
|
+
* Get Part OrderBook
|
|
110
|
+
* Query for part orderbook depth data. (aggregated by price)
|
|
111
|
+
*/
|
|
98
112
|
getPartOrderBookLevel2Depth20(params) {
|
|
99
113
|
return this.get('api/v1/level2/depth20', params);
|
|
100
114
|
}
|
|
115
|
+
/**
|
|
116
|
+
* Get Part OrderBook
|
|
117
|
+
* Query for part orderbook depth data. (aggregated by price)
|
|
118
|
+
*/
|
|
101
119
|
getPartOrderBookLevel2Depth100(params) {
|
|
102
120
|
return this.get('api/v1/level2/depth100', params);
|
|
103
121
|
}
|
|
122
|
+
/**
|
|
123
|
+
* Get Trade History
|
|
124
|
+
* Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.
|
|
125
|
+
*/
|
|
104
126
|
getMarketTrades(params) {
|
|
105
127
|
return this.get('api/v1/trade/history', params);
|
|
106
128
|
}
|
|
129
|
+
/**
|
|
130
|
+
* Get Klines
|
|
131
|
+
* Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.
|
|
132
|
+
*/
|
|
107
133
|
getKlines(params) {
|
|
108
134
|
return this.get('api/v1/kline/query', params);
|
|
109
135
|
}
|
|
110
|
-
|
|
111
|
-
|
|
136
|
+
/**
|
|
137
|
+
* Get Mark Price
|
|
138
|
+
* Get the mark price of the symbol.
|
|
139
|
+
*/
|
|
140
|
+
getMarkPrice(params) {
|
|
141
|
+
return this.get(`api/v1/mark-price/${params.symbol}/current`);
|
|
112
142
|
}
|
|
143
|
+
/**
|
|
144
|
+
* Get Spot Index Price
|
|
145
|
+
* This endpoint returns the index price of the specified symbol.
|
|
146
|
+
*/
|
|
113
147
|
getIndex(params) {
|
|
114
148
|
return this.get('api/v1/index/query', params);
|
|
115
149
|
}
|
|
116
|
-
|
|
117
|
-
|
|
150
|
+
/**
|
|
151
|
+
* Get Interest Rate Index
|
|
152
|
+
* This endpoint returns the interest rate index of the specified symbol.
|
|
153
|
+
*/
|
|
154
|
+
getInterestRates(params) {
|
|
155
|
+
return this.get('api/v1/interest/query', params);
|
|
118
156
|
}
|
|
157
|
+
/**
|
|
158
|
+
* Get Premium Index
|
|
159
|
+
* This endpoint returns the premium index of the specified symbol.
|
|
160
|
+
*/
|
|
119
161
|
getPremiumIndex(params) {
|
|
120
162
|
return this.get('api/v1/premium/query', params);
|
|
121
163
|
}
|
|
164
|
+
/**
|
|
165
|
+
* Get 24hr Stats
|
|
166
|
+
* Get the statistics of the platform futures trading volume in the last 24 hours.
|
|
167
|
+
*/
|
|
122
168
|
get24HourTransactionVolume() {
|
|
123
169
|
return this.get('api/v1/trade-statistics');
|
|
124
170
|
}
|
|
171
|
+
/**
|
|
172
|
+
* Get Server Time
|
|
173
|
+
* Get the API server time. This is the Unix timestamp.
|
|
174
|
+
*/
|
|
175
|
+
getServerTime() {
|
|
176
|
+
return this.get('api/v1/timestamp');
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Get Service Status
|
|
180
|
+
* This endpoint returns the status of the API service.
|
|
181
|
+
*/
|
|
182
|
+
getServiceStatus() {
|
|
183
|
+
return this.get('api/v1/status');
|
|
184
|
+
}
|
|
125
185
|
/**
|
|
126
186
|
*
|
|
127
|
-
* REST -
|
|
187
|
+
* REST - Futures Trading - Orders
|
|
128
188
|
*
|
|
129
189
|
*/
|
|
190
|
+
/**
|
|
191
|
+
* Add Order
|
|
192
|
+
* Place order to the futures trading system
|
|
193
|
+
*/
|
|
130
194
|
submitOrder(params) {
|
|
131
195
|
return this.postPrivate('api/v1/orders', params);
|
|
132
196
|
}
|
|
133
|
-
|
|
134
|
-
|
|
197
|
+
/**
|
|
198
|
+
* Add Order Test
|
|
199
|
+
* Order test endpoint, the request parameters and return parameters of this endpoint are exactly the same as the order endpoint, and can be used to verify whether the signature is correct and other operations.
|
|
200
|
+
*/
|
|
201
|
+
submitNewOrderTest(params) {
|
|
202
|
+
return this.postPrivate('api/v1/orders/test', params);
|
|
135
203
|
}
|
|
204
|
+
/**
|
|
205
|
+
* Batch Add Orders
|
|
206
|
+
* Place multiple order to the futures trading system
|
|
207
|
+
*/
|
|
208
|
+
submitMultipleOrders(params) {
|
|
209
|
+
return this.postPrivate('api/v1/orders/multi', params);
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* Add Take Profit And Stop Loss Order
|
|
213
|
+
* Place take profit and stop loss order supports both take-profit and stop-loss functions, and other functions are exactly the same as the place order interface.
|
|
214
|
+
*/
|
|
215
|
+
submitSLTPOrder(params) {
|
|
216
|
+
return this.postPrivate('api/v1/st-orders', params);
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* Cancel Order By OrderId
|
|
220
|
+
* Cancel an order (including a stop order).
|
|
221
|
+
*/
|
|
136
222
|
cancelOrderById(params) {
|
|
137
223
|
return this.deletePrivate(`api/v1/orders/${params.orderId}`);
|
|
138
224
|
}
|
|
225
|
+
/**
|
|
226
|
+
* Cancel Order By Client Order Id
|
|
227
|
+
* Cancel an order (including a stop order) by client order id.
|
|
228
|
+
*/
|
|
139
229
|
cancelOrderByClientOid(params) {
|
|
140
230
|
return this.deletePrivate(`api/v1/orders/client-order/${params.clientOid}`);
|
|
141
231
|
}
|
|
232
|
+
/**
|
|
233
|
+
* Batch Cancel Orders
|
|
234
|
+
* Cancel multiple orders.
|
|
235
|
+
*/
|
|
142
236
|
batchCancelOrders(params) {
|
|
143
237
|
return this.deletePrivate('api/v1/orders/multi-cancel', params);
|
|
144
238
|
}
|
|
145
|
-
submitSLTPOrder(params) {
|
|
146
|
-
return this.postPrivate('api/v1/st-orders', params);
|
|
147
|
-
}
|
|
148
|
-
submitMultipleOrders(params) {
|
|
149
|
-
return this.postPrivate('api/v1/orders/multi', params);
|
|
150
|
-
}
|
|
151
239
|
/**
|
|
152
|
-
*
|
|
240
|
+
* Cancel All Orders
|
|
241
|
+
* Using this endpoint, all open orders (excluding stop orders) can be canceled in batches.
|
|
153
242
|
*/
|
|
154
|
-
cancelAllOrders(params) {
|
|
155
|
-
return this.deletePrivate('api/v1/orders', params);
|
|
156
|
-
}
|
|
157
243
|
cancelAllOrdersV3(params) {
|
|
158
244
|
return this.deletePrivate('api/v3/orders', params);
|
|
159
245
|
}
|
|
246
|
+
/**
|
|
247
|
+
* Cancel All Stop orders
|
|
248
|
+
* Using this endpoint, all untriggered stop orders can be canceled in batches.
|
|
249
|
+
*/
|
|
160
250
|
cancelAllStopOrders(params) {
|
|
161
251
|
return this.deletePrivate('api/v1/stopOrders', params);
|
|
162
252
|
}
|
|
253
|
+
/**
|
|
254
|
+
* Get Order By OrderId
|
|
255
|
+
* Get order details by order id.
|
|
256
|
+
*/
|
|
257
|
+
getOrderByOrderId(params) {
|
|
258
|
+
return this.getPrivate(`api/v1/orders/${params.orderId}`);
|
|
259
|
+
}
|
|
260
|
+
/**
|
|
261
|
+
* Get Order By Client Order Id
|
|
262
|
+
* Get order details by client order id.
|
|
263
|
+
*/
|
|
264
|
+
getOrderByClientOrderId(params) {
|
|
265
|
+
return this.getPrivate(`api/v1/orders/byClientOid`, params);
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* Get Order List
|
|
269
|
+
* List your current orders. Any limit order on the exchange order book is in active status.
|
|
270
|
+
*/
|
|
163
271
|
getOrders(params) {
|
|
164
272
|
return this.getPrivate('api/v1/orders', params);
|
|
165
273
|
}
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
274
|
+
/**
|
|
275
|
+
* Get Recent Closed Orders
|
|
276
|
+
* Get a list of recent 1000 closed orders in the last 24 hours.
|
|
277
|
+
*/
|
|
169
278
|
getRecentOrders(params) {
|
|
170
279
|
return this.getPrivate('api/v1/recentDoneOrders', params);
|
|
171
280
|
}
|
|
172
|
-
|
|
173
|
-
|
|
281
|
+
/**
|
|
282
|
+
* Get Stop Order List
|
|
283
|
+
* Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface
|
|
284
|
+
*/
|
|
285
|
+
getStopOrders(params) {
|
|
286
|
+
return this.getPrivate('api/v1/stopOrders', params);
|
|
174
287
|
}
|
|
175
|
-
|
|
176
|
-
|
|
288
|
+
/**
|
|
289
|
+
* Get Open Order Value
|
|
290
|
+
* You can query this endpoint to get the the total number and value of the all your active orders.
|
|
291
|
+
*/
|
|
292
|
+
getOpenOrderStatistics(params) {
|
|
293
|
+
return this.getPrivate('api/v1/openOrderStatistics', params);
|
|
177
294
|
}
|
|
178
295
|
/**
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
296
|
+
* Get Recent Trade History
|
|
297
|
+
* Get a list of recent 1000 fills in the last 24 hours.
|
|
182
298
|
*/
|
|
299
|
+
getRecentFills(params) {
|
|
300
|
+
return this.getPrivate('api/v1/recentFills', params);
|
|
301
|
+
}
|
|
183
302
|
/**
|
|
303
|
+
* Get Trade History
|
|
184
304
|
* Get a list of recent fills.
|
|
185
|
-
*
|
|
186
|
-
* If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h.
|
|
187
|
-
* The requested data is not real-time.
|
|
305
|
+
* If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h. The requested data is not real-time.
|
|
188
306
|
*/
|
|
189
307
|
getFills(params) {
|
|
190
308
|
return this.getPrivate('api/v1/fills', params);
|
|
191
309
|
}
|
|
192
310
|
/**
|
|
193
|
-
* Get a list of recent 1000 fills in the last 24 hours.
|
|
194
311
|
*
|
|
195
|
-
*
|
|
312
|
+
* REST - Futures Trading - Positions
|
|
313
|
+
*
|
|
196
314
|
*/
|
|
197
|
-
|
|
198
|
-
|
|
315
|
+
/**
|
|
316
|
+
* Get Margin Mode
|
|
317
|
+
* This interface can query the margin mode of the current symbol.
|
|
318
|
+
*/
|
|
319
|
+
getMarginMode(params) {
|
|
320
|
+
return this.getPrivate('api/v2/position/getMarginMode', params);
|
|
199
321
|
}
|
|
200
|
-
|
|
201
|
-
|
|
322
|
+
/**
|
|
323
|
+
* Switch Margin Mode
|
|
324
|
+
* Modify the margin mode of the current symbol.
|
|
325
|
+
*/
|
|
326
|
+
updateMarginMode(params) {
|
|
327
|
+
return this.postPrivate('api/v2/position/changeMarginMode', params);
|
|
202
328
|
}
|
|
203
329
|
/**
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
330
|
+
* Get Max Open Size
|
|
331
|
+
* Get Maximum Open Position Size.
|
|
207
332
|
*/
|
|
208
333
|
getMaxOpenSize(params) {
|
|
209
334
|
return this.getPrivate('api/v2/getMaxOpenSize', params);
|
|
210
335
|
}
|
|
336
|
+
/**
|
|
337
|
+
* Get Position Details
|
|
338
|
+
* Get the position details of a specified position.
|
|
339
|
+
*/
|
|
211
340
|
getPosition(params) {
|
|
212
341
|
return this.getPrivate('api/v1/position', params);
|
|
213
342
|
}
|
|
343
|
+
/**
|
|
344
|
+
* Get Position List
|
|
345
|
+
* Get the position details of a specified position.
|
|
346
|
+
*/
|
|
214
347
|
getPositions(params) {
|
|
215
348
|
return this.getPrivate('api/v1/positions', params);
|
|
216
349
|
}
|
|
350
|
+
/**
|
|
351
|
+
* Get Positions History
|
|
352
|
+
* This interface can query position history information records.
|
|
353
|
+
*/
|
|
217
354
|
getHistoryPositions(params) {
|
|
218
355
|
return this.getPrivate('api/v1/history-positions', params);
|
|
219
356
|
}
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
357
|
+
/**
|
|
358
|
+
* Get Max Withdraw Margin
|
|
359
|
+
* This interface can query the maximum amount of margin that the current position supports withdrawal.
|
|
360
|
+
*/
|
|
223
361
|
getMaxWithdrawMargin(params) {
|
|
224
362
|
return this.getPrivate('api/v1/margin/maxWithdrawMargin', params);
|
|
225
363
|
}
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
return this.postPrivate('api/v1/position/margin/deposit-margin', params);
|
|
231
|
-
}
|
|
232
|
-
getMarginMode(params) {
|
|
233
|
-
return this.getPrivate('api/v2/position/getMarginMode', params);
|
|
234
|
-
}
|
|
235
|
-
updateMarginMode(params) {
|
|
236
|
-
return this.postPrivate('api/v2/position/changeMarginMode', params);
|
|
237
|
-
}
|
|
364
|
+
/**
|
|
365
|
+
* Get Cross Margin Leverage
|
|
366
|
+
* This interface can query the current symbol’s cross-margin leverage multiple.
|
|
367
|
+
*/
|
|
238
368
|
getCrossMarginLeverage(params) {
|
|
239
369
|
return this.getPrivate('api/v2/getCrossUserLeverage', params);
|
|
240
370
|
}
|
|
371
|
+
/**
|
|
372
|
+
* Modify Cross Margin Leverage
|
|
373
|
+
* This interface can modify the current symbol’s cross-margin leverage multiple.
|
|
374
|
+
*/
|
|
241
375
|
changeCrossMarginLeverage(params) {
|
|
242
376
|
return this.postPrivate('api/v2/changeCrossUserLeverage', params);
|
|
243
377
|
}
|
|
244
378
|
/**
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
|
|
379
|
+
* Add Isolated Margin
|
|
380
|
+
* Add Isolated Margin Manually.
|
|
381
|
+
*/
|
|
382
|
+
depositMargin(params) {
|
|
383
|
+
return this.postPrivate('api/v1/position/margin/deposit-margin', params);
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
* Remove Isolated Margin
|
|
387
|
+
* Remove Isolated Margin Manually.
|
|
388
|
+
*/
|
|
389
|
+
withdrawMargin(params) {
|
|
390
|
+
return this.postPrivate('api/v1/margin/withdrawMargin', params);
|
|
391
|
+
}
|
|
392
|
+
/**
|
|
393
|
+
* Get Isolated Margin Risk Limit
|
|
394
|
+
* This interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).
|
|
248
395
|
*/
|
|
249
396
|
getRiskLimitLevel(params) {
|
|
250
397
|
return this.getPrivate(`api/v1/contracts/risk-limit/${params.symbol}`);
|
|
251
398
|
}
|
|
399
|
+
/**
|
|
400
|
+
* Modify Isolated Margin Risk Limit
|
|
401
|
+
* This interface is for the adjustment of the risk limit level(Only valid for isolated Margin).
|
|
402
|
+
*/
|
|
252
403
|
updateRiskLimitLevel(params) {
|
|
253
404
|
return this.postPrivate('api/v1/position/risk-limit-level/change', params);
|
|
254
405
|
}
|
|
255
406
|
/**
|
|
256
407
|
*
|
|
257
|
-
* REST -
|
|
408
|
+
* REST - Futures Trading - Funding Fees
|
|
258
409
|
*
|
|
259
410
|
*/
|
|
411
|
+
/**
|
|
412
|
+
* Get Current Funding Rate
|
|
413
|
+
* This interface can be used to obtain the current funding rate of the specified symbol.
|
|
414
|
+
*/
|
|
260
415
|
getFundingRate(params) {
|
|
261
416
|
return this.get(`api/v1/funding-rate/${params.symbol}/current`);
|
|
262
417
|
}
|
|
418
|
+
/**
|
|
419
|
+
* Get Public Funding History
|
|
420
|
+
* Query the funding rate at each settlement time point within a certain time range of the corresponding contract
|
|
421
|
+
*/
|
|
263
422
|
getFundingRates(params) {
|
|
264
423
|
return this.get('api/v1/contract/funding-rates', params);
|
|
265
424
|
}
|
|
425
|
+
/**
|
|
426
|
+
* Get Private Funding History
|
|
427
|
+
* Submit request to get the funding history.
|
|
428
|
+
*/
|
|
266
429
|
getFundingHistory(params) {
|
|
267
430
|
return this.getPrivate('api/v1/funding-history', params);
|
|
268
431
|
}
|
|
@@ -285,5 +448,35 @@ export class FuturesClient extends BaseRestClient {
|
|
|
285
448
|
getPrivateWSConnectionToken() {
|
|
286
449
|
return this.postPrivate('api/v1/bullet-private');
|
|
287
450
|
}
|
|
451
|
+
/*
|
|
452
|
+
*
|
|
453
|
+
* DEPRECATED
|
|
454
|
+
*
|
|
455
|
+
*/
|
|
456
|
+
/**
|
|
457
|
+
* @deprecated - please use universal transfer from SpotClient
|
|
458
|
+
*/
|
|
459
|
+
submitTransferOut(params) {
|
|
460
|
+
return this.postPrivate('api/v3/transfer-out', params);
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* @deprecated - please use universal transfer from SpotClient
|
|
464
|
+
*/
|
|
465
|
+
submitTransferIn(params) {
|
|
466
|
+
return this.postPrivate('api/v1/transfer-in', params);
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* @deprecated - please use universal transfer from SpotClient
|
|
470
|
+
*/
|
|
471
|
+
getTransfers(params) {
|
|
472
|
+
return this.getPrivate('api/v1/transfer-list', params);
|
|
473
|
+
}
|
|
474
|
+
/**
|
|
475
|
+
* @deprecated - please use updateMarginMode() instead
|
|
476
|
+
*/
|
|
477
|
+
updateAutoDepositStatus(params) {
|
|
478
|
+
console.warn('WARNING: This method is deprecated. It is recommended to use cross margin mode instead.');
|
|
479
|
+
return this.postPrivate('api/v1/position/margin/auto-deposit-status', params);
|
|
480
|
+
}
|
|
288
481
|
}
|
|
289
482
|
//# sourceMappingURL=FuturesClient.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FuturesClient.js","sourceRoot":"","sources":["../../src/FuturesClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"FuturesClient.js","sourceRoot":"","sources":["../../src/FuturesClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;AAmD/B;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,cAAc;IAC/C,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;QACX,OAAO,qBAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IAEH,kBAAkB;QAChB,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED;;;;OAIG;IAEH;;;OAGG;IACH,UAAU,CAAC,MAEV;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,MAA8B;QAM5C,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IAEH;;;OAGG;IACH,cAAc,CAAC,MAA8B;QAM3C,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IAEH;;;OAGG;IACH,iBAAiB,CAAC,MAA0B;QAO1C,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,SAAS,CAAC,MAET;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,MAET;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,6BAA6B,CAAC,MAE7B;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,8BAA8B,CAAC,MAE9B;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,MAAwB;QAExB,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,MAEZ;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAqB,MAAM,CAAC,MAAM,UAAU,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,MAA+B;QAMtC,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,MAA+B;QAM9C,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,MAA+B;QAM7C,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,0BAA0B;QAKxB,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IAEH;;;OAGG;IACH,WAAW,CAAC,MAAa;QAMvB,OAAO,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,MAAa;QAI9B,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAClB,MAAe;QAEf,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,MAAiB;QAM/B,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,8BAA8B,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,MAAgC;QAKhD,OAAO,IAAI,CAAC,aAAa,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,MAEjB;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAC,MAEnB;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,MAEjB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,uBAAuB,CAAC,MAEvB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,SAAS,CACP,MAAyB;QAEzB,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACH,aAAa,CACX,MAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,MAEd;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACH,QAAQ,CACN,MAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IAEH;;;OAGG;IACH,aAAa,CAAC,MAA0B;QAMtC,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,MAGhB;QAMC,OAAO,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,cAAc,CACZ,MAA0B;QAE1B,OAAO,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,MAEX;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,MAEZ;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAC,MAMnB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAAC,MAEpB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACH,sBAAsB,CAAC,MAA0B;QAM/C,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,MAGzB;QAMC,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,MAIb;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,MAGd;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,MAEjB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAAC,MAGpB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IAEH;;;OAGG;IACH,cAAc,CAAC,MAEd;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,MAAM,CAAC,MAAM,UAAU,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,eAAe,CACb,MAA8B;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,MAAgC;QAMhD,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,gCAAgC,CAAC,MAIhC;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IAEH,0BAA0B;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC3C,CAAC;IAED,2BAA2B;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IAEH;;OAEG;IACH,iBAAiB,CAAC,MAIjB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,MAIhB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,MAQZ;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,uBAAuB,CAAC,MAGvB;QACC,OAAO,CAAC,IAAI,CACV,yFAAyF,CAC1F,CAAC;QACF,OAAO,IAAI,CAAC,WAAW,CACrB,4CAA4C,EAC5C,MAAM,CACP,CAAC;IACJ,CAAC;CACF"}
|