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
|
@@ -23,249 +23,412 @@ class FuturesClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
23
23
|
generateNewOrderID() {
|
|
24
24
|
return (0, nanoid_1.nanoid)(32);
|
|
25
25
|
}
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* REST - ACCOUNT INFO - Account & Funding
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
/**
|
|
32
|
+
* Get Account - Futures
|
|
33
|
+
* Request via this endpoint to get the info of the futures account.
|
|
34
|
+
*/
|
|
35
|
+
getBalance(params) {
|
|
36
|
+
return this.getPrivate('api/v1/account-overview', params);
|
|
31
37
|
}
|
|
32
38
|
/**
|
|
33
|
-
* REST - ACCOUNT - BASIC INFO
|
|
34
39
|
* Get Account Ledgers - Futures
|
|
40
|
+
* This interface can query the ledger records of the futures business line
|
|
35
41
|
*/
|
|
36
42
|
getTransactions(params) {
|
|
37
43
|
return this.getPrivate('api/v1/transaction-history', params);
|
|
38
44
|
}
|
|
39
45
|
/**
|
|
40
|
-
*
|
|
46
|
+
*
|
|
47
|
+
* REST - ACCOUNT INFO - Sub Account
|
|
48
|
+
*
|
|
41
49
|
*/
|
|
42
|
-
getSubAPIs(params) {
|
|
43
|
-
return this.getPrivate('api/v1/sub/api-key', params);
|
|
44
|
-
}
|
|
45
|
-
createSubAPI(params) {
|
|
46
|
-
return this.postPrivate('api/v1/sub/api-key', params);
|
|
47
|
-
}
|
|
48
|
-
updateSubAPI(params) {
|
|
49
|
-
return this.postPrivate('api/v1/sub/api-key/update', params);
|
|
50
|
-
}
|
|
51
|
-
deleteSubAPI(params) {
|
|
52
|
-
return this.deletePrivate('api/v1/sub/api-key', params);
|
|
53
|
-
}
|
|
54
50
|
/**
|
|
55
|
-
*
|
|
51
|
+
* Get SubAccount List - Futures Balance(V2)
|
|
52
|
+
* This endpoint can be used to get Futures sub-account information.
|
|
56
53
|
*/
|
|
57
|
-
getBalance(params) {
|
|
58
|
-
return this.getPrivate('api/v1/account-overview', params);
|
|
59
|
-
}
|
|
60
54
|
getSubBalances(params) {
|
|
61
55
|
return this.getPrivate('api/v1/account-overview-all', params);
|
|
62
56
|
}
|
|
63
57
|
/**
|
|
64
|
-
*
|
|
58
|
+
*
|
|
59
|
+
* REST - Account Info - Trade Fee
|
|
60
|
+
*
|
|
65
61
|
*/
|
|
66
|
-
submitTransferOut(params) {
|
|
67
|
-
return this.postPrivate('api/v3/transfer-out', params);
|
|
68
|
-
}
|
|
69
|
-
submitTransferIn(params) {
|
|
70
|
-
return this.postPrivate('api/v1/transfer-in', params);
|
|
71
|
-
}
|
|
72
|
-
getTransfers(params) {
|
|
73
|
-
return this.getPrivate('api/v1/transfer-list', params);
|
|
74
|
-
}
|
|
75
62
|
/**
|
|
76
|
-
*
|
|
63
|
+
* Get Actual Fee - Futures
|
|
64
|
+
* 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.
|
|
77
65
|
*/
|
|
78
66
|
getTradingPairFee(params) {
|
|
79
67
|
return this.getPrivate('api/v1/trade-fees', params);
|
|
80
68
|
}
|
|
81
69
|
/**
|
|
82
70
|
*
|
|
83
|
-
* REST -
|
|
71
|
+
* REST - Futures Trading - Market Data
|
|
84
72
|
*
|
|
85
73
|
*/
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
74
|
+
/**
|
|
75
|
+
* Get Symbol
|
|
76
|
+
* Get information of specified contracts that can be traded.
|
|
77
|
+
* 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.
|
|
78
|
+
*/
|
|
89
79
|
getSymbol(params) {
|
|
90
80
|
return this.get(`api/v1/contracts/${params.symbol}`);
|
|
91
81
|
}
|
|
82
|
+
/**
|
|
83
|
+
* Get Symbol
|
|
84
|
+
* Get information of specified contracts that can be traded.
|
|
85
|
+
* 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.
|
|
86
|
+
*/
|
|
87
|
+
getSymbols() {
|
|
88
|
+
return this.get('api/v1/contracts/active');
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Get Ticker
|
|
92
|
+
* This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of a single symbol.
|
|
93
|
+
*/
|
|
92
94
|
getTicker(params) {
|
|
93
95
|
return this.get('api/v1/ticker', params);
|
|
94
96
|
}
|
|
97
|
+
/**
|
|
98
|
+
* Get All Tickers
|
|
99
|
+
* This endpoint returns "last traded price/size"、"best bid/ask price/size" etc. of all symbol.
|
|
100
|
+
*/
|
|
95
101
|
getTickers() {
|
|
96
102
|
return this.get('api/v1/allTickers');
|
|
97
103
|
}
|
|
104
|
+
/**
|
|
105
|
+
* Get Full OrderBook
|
|
106
|
+
* Query for Full orderbook depth data. (aggregated by price)
|
|
107
|
+
*/
|
|
98
108
|
getFullOrderBookLevel2(params) {
|
|
99
109
|
return this.get('api/v1/level2/snapshot', params);
|
|
100
110
|
}
|
|
111
|
+
/**
|
|
112
|
+
* Get Part OrderBook
|
|
113
|
+
* Query for part orderbook depth data. (aggregated by price)
|
|
114
|
+
*/
|
|
101
115
|
getPartOrderBookLevel2Depth20(params) {
|
|
102
116
|
return this.get('api/v1/level2/depth20', params);
|
|
103
117
|
}
|
|
118
|
+
/**
|
|
119
|
+
* Get Part OrderBook
|
|
120
|
+
* Query for part orderbook depth data. (aggregated by price)
|
|
121
|
+
*/
|
|
104
122
|
getPartOrderBookLevel2Depth100(params) {
|
|
105
123
|
return this.get('api/v1/level2/depth100', params);
|
|
106
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
* Get Trade History
|
|
127
|
+
* Request via this endpoint to get the trade history of the specified symbol, the returned quantity is the last 100 transaction records.
|
|
128
|
+
*/
|
|
107
129
|
getMarketTrades(params) {
|
|
108
130
|
return this.get('api/v1/trade/history', params);
|
|
109
131
|
}
|
|
132
|
+
/**
|
|
133
|
+
* Get Klines
|
|
134
|
+
* Get the Kline of the symbol. Data are returned in grouped buckets based on requested type.
|
|
135
|
+
*/
|
|
110
136
|
getKlines(params) {
|
|
111
137
|
return this.get('api/v1/kline/query', params);
|
|
112
138
|
}
|
|
113
|
-
|
|
114
|
-
|
|
139
|
+
/**
|
|
140
|
+
* Get Mark Price
|
|
141
|
+
* Get the mark price of the symbol.
|
|
142
|
+
*/
|
|
143
|
+
getMarkPrice(params) {
|
|
144
|
+
return this.get(`api/v1/mark-price/${params.symbol}/current`);
|
|
115
145
|
}
|
|
146
|
+
/**
|
|
147
|
+
* Get Spot Index Price
|
|
148
|
+
* This endpoint returns the index price of the specified symbol.
|
|
149
|
+
*/
|
|
116
150
|
getIndex(params) {
|
|
117
151
|
return this.get('api/v1/index/query', params);
|
|
118
152
|
}
|
|
119
|
-
|
|
120
|
-
|
|
153
|
+
/**
|
|
154
|
+
* Get Interest Rate Index
|
|
155
|
+
* This endpoint returns the interest rate index of the specified symbol.
|
|
156
|
+
*/
|
|
157
|
+
getInterestRates(params) {
|
|
158
|
+
return this.get('api/v1/interest/query', params);
|
|
121
159
|
}
|
|
160
|
+
/**
|
|
161
|
+
* Get Premium Index
|
|
162
|
+
* This endpoint returns the premium index of the specified symbol.
|
|
163
|
+
*/
|
|
122
164
|
getPremiumIndex(params) {
|
|
123
165
|
return this.get('api/v1/premium/query', params);
|
|
124
166
|
}
|
|
167
|
+
/**
|
|
168
|
+
* Get 24hr Stats
|
|
169
|
+
* Get the statistics of the platform futures trading volume in the last 24 hours.
|
|
170
|
+
*/
|
|
125
171
|
get24HourTransactionVolume() {
|
|
126
172
|
return this.get('api/v1/trade-statistics');
|
|
127
173
|
}
|
|
174
|
+
/**
|
|
175
|
+
* Get Server Time
|
|
176
|
+
* Get the API server time. This is the Unix timestamp.
|
|
177
|
+
*/
|
|
178
|
+
getServerTime() {
|
|
179
|
+
return this.get('api/v1/timestamp');
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Get Service Status
|
|
183
|
+
* This endpoint returns the status of the API service.
|
|
184
|
+
*/
|
|
185
|
+
getServiceStatus() {
|
|
186
|
+
return this.get('api/v1/status');
|
|
187
|
+
}
|
|
128
188
|
/**
|
|
129
189
|
*
|
|
130
|
-
* REST -
|
|
190
|
+
* REST - Futures Trading - Orders
|
|
131
191
|
*
|
|
132
192
|
*/
|
|
193
|
+
/**
|
|
194
|
+
* Add Order
|
|
195
|
+
* Place order to the futures trading system
|
|
196
|
+
*/
|
|
133
197
|
submitOrder(params) {
|
|
134
198
|
return this.postPrivate('api/v1/orders', params);
|
|
135
199
|
}
|
|
136
|
-
|
|
137
|
-
|
|
200
|
+
/**
|
|
201
|
+
* Add Order Test
|
|
202
|
+
* 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.
|
|
203
|
+
*/
|
|
204
|
+
submitNewOrderTest(params) {
|
|
205
|
+
return this.postPrivate('api/v1/orders/test', params);
|
|
138
206
|
}
|
|
207
|
+
/**
|
|
208
|
+
* Batch Add Orders
|
|
209
|
+
* Place multiple order to the futures trading system
|
|
210
|
+
*/
|
|
211
|
+
submitMultipleOrders(params) {
|
|
212
|
+
return this.postPrivate('api/v1/orders/multi', params);
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* Add Take Profit And Stop Loss Order
|
|
216
|
+
* 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.
|
|
217
|
+
*/
|
|
218
|
+
submitSLTPOrder(params) {
|
|
219
|
+
return this.postPrivate('api/v1/st-orders', params);
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* Cancel Order By OrderId
|
|
223
|
+
* Cancel an order (including a stop order).
|
|
224
|
+
*/
|
|
139
225
|
cancelOrderById(params) {
|
|
140
226
|
return this.deletePrivate(`api/v1/orders/${params.orderId}`);
|
|
141
227
|
}
|
|
228
|
+
/**
|
|
229
|
+
* Cancel Order By Client Order Id
|
|
230
|
+
* Cancel an order (including a stop order) by client order id.
|
|
231
|
+
*/
|
|
142
232
|
cancelOrderByClientOid(params) {
|
|
143
233
|
return this.deletePrivate(`api/v1/orders/client-order/${params.clientOid}`);
|
|
144
234
|
}
|
|
235
|
+
/**
|
|
236
|
+
* Batch Cancel Orders
|
|
237
|
+
* Cancel multiple orders.
|
|
238
|
+
*/
|
|
145
239
|
batchCancelOrders(params) {
|
|
146
240
|
return this.deletePrivate('api/v1/orders/multi-cancel', params);
|
|
147
241
|
}
|
|
148
|
-
submitSLTPOrder(params) {
|
|
149
|
-
return this.postPrivate('api/v1/st-orders', params);
|
|
150
|
-
}
|
|
151
|
-
submitMultipleOrders(params) {
|
|
152
|
-
return this.postPrivate('api/v1/orders/multi', params);
|
|
153
|
-
}
|
|
154
242
|
/**
|
|
155
|
-
*
|
|
243
|
+
* Cancel All Orders
|
|
244
|
+
* Using this endpoint, all open orders (excluding stop orders) can be canceled in batches.
|
|
156
245
|
*/
|
|
157
|
-
cancelAllOrders(params) {
|
|
158
|
-
return this.deletePrivate('api/v1/orders', params);
|
|
159
|
-
}
|
|
160
246
|
cancelAllOrdersV3(params) {
|
|
161
247
|
return this.deletePrivate('api/v3/orders', params);
|
|
162
248
|
}
|
|
249
|
+
/**
|
|
250
|
+
* Cancel All Stop orders
|
|
251
|
+
* Using this endpoint, all untriggered stop orders can be canceled in batches.
|
|
252
|
+
*/
|
|
163
253
|
cancelAllStopOrders(params) {
|
|
164
254
|
return this.deletePrivate('api/v1/stopOrders', params);
|
|
165
255
|
}
|
|
256
|
+
/**
|
|
257
|
+
* Get Order By OrderId
|
|
258
|
+
* Get order details by order id.
|
|
259
|
+
*/
|
|
260
|
+
getOrderByOrderId(params) {
|
|
261
|
+
return this.getPrivate(`api/v1/orders/${params.orderId}`);
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* Get Order By Client Order Id
|
|
265
|
+
* Get order details by client order id.
|
|
266
|
+
*/
|
|
267
|
+
getOrderByClientOrderId(params) {
|
|
268
|
+
return this.getPrivate(`api/v1/orders/byClientOid`, params);
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* Get Order List
|
|
272
|
+
* List your current orders. Any limit order on the exchange order book is in active status.
|
|
273
|
+
*/
|
|
166
274
|
getOrders(params) {
|
|
167
275
|
return this.getPrivate('api/v1/orders', params);
|
|
168
276
|
}
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
277
|
+
/**
|
|
278
|
+
* Get Recent Closed Orders
|
|
279
|
+
* Get a list of recent 1000 closed orders in the last 24 hours.
|
|
280
|
+
*/
|
|
172
281
|
getRecentOrders(params) {
|
|
173
282
|
return this.getPrivate('api/v1/recentDoneOrders', params);
|
|
174
283
|
}
|
|
175
|
-
|
|
176
|
-
|
|
284
|
+
/**
|
|
285
|
+
* Get Stop Order List
|
|
286
|
+
* Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface
|
|
287
|
+
*/
|
|
288
|
+
getStopOrders(params) {
|
|
289
|
+
return this.getPrivate('api/v1/stopOrders', params);
|
|
177
290
|
}
|
|
178
|
-
|
|
179
|
-
|
|
291
|
+
/**
|
|
292
|
+
* Get Open Order Value
|
|
293
|
+
* You can query this endpoint to get the the total number and value of the all your active orders.
|
|
294
|
+
*/
|
|
295
|
+
getOpenOrderStatistics(params) {
|
|
296
|
+
return this.getPrivate('api/v1/openOrderStatistics', params);
|
|
180
297
|
}
|
|
181
298
|
/**
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
*
|
|
299
|
+
* Get Recent Trade History
|
|
300
|
+
* Get a list of recent 1000 fills in the last 24 hours.
|
|
185
301
|
*/
|
|
302
|
+
getRecentFills(params) {
|
|
303
|
+
return this.getPrivate('api/v1/recentFills', params);
|
|
304
|
+
}
|
|
186
305
|
/**
|
|
306
|
+
* Get Trade History
|
|
187
307
|
* Get a list of recent fills.
|
|
188
|
-
*
|
|
189
|
-
* If you need to get your recent trade history with low latency, please query endpoint Get List of Orders Completed in 24h.
|
|
190
|
-
* The requested data is not real-time.
|
|
308
|
+
* 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.
|
|
191
309
|
*/
|
|
192
310
|
getFills(params) {
|
|
193
311
|
return this.getPrivate('api/v1/fills', params);
|
|
194
312
|
}
|
|
195
313
|
/**
|
|
196
|
-
* Get a list of recent 1000 fills in the last 24 hours.
|
|
197
314
|
*
|
|
198
|
-
*
|
|
315
|
+
* REST - Futures Trading - Positions
|
|
316
|
+
*
|
|
199
317
|
*/
|
|
200
|
-
|
|
201
|
-
|
|
318
|
+
/**
|
|
319
|
+
* Get Margin Mode
|
|
320
|
+
* This interface can query the margin mode of the current symbol.
|
|
321
|
+
*/
|
|
322
|
+
getMarginMode(params) {
|
|
323
|
+
return this.getPrivate('api/v2/position/getMarginMode', params);
|
|
202
324
|
}
|
|
203
|
-
|
|
204
|
-
|
|
325
|
+
/**
|
|
326
|
+
* Switch Margin Mode
|
|
327
|
+
* Modify the margin mode of the current symbol.
|
|
328
|
+
*/
|
|
329
|
+
updateMarginMode(params) {
|
|
330
|
+
return this.postPrivate('api/v2/position/changeMarginMode', params);
|
|
205
331
|
}
|
|
206
332
|
/**
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
*
|
|
333
|
+
* Get Max Open Size
|
|
334
|
+
* Get Maximum Open Position Size.
|
|
210
335
|
*/
|
|
211
336
|
getMaxOpenSize(params) {
|
|
212
337
|
return this.getPrivate('api/v2/getMaxOpenSize', params);
|
|
213
338
|
}
|
|
339
|
+
/**
|
|
340
|
+
* Get Position Details
|
|
341
|
+
* Get the position details of a specified position.
|
|
342
|
+
*/
|
|
214
343
|
getPosition(params) {
|
|
215
344
|
return this.getPrivate('api/v1/position', params);
|
|
216
345
|
}
|
|
346
|
+
/**
|
|
347
|
+
* Get Position List
|
|
348
|
+
* Get the position details of a specified position.
|
|
349
|
+
*/
|
|
217
350
|
getPositions(params) {
|
|
218
351
|
return this.getPrivate('api/v1/positions', params);
|
|
219
352
|
}
|
|
353
|
+
/**
|
|
354
|
+
* Get Positions History
|
|
355
|
+
* This interface can query position history information records.
|
|
356
|
+
*/
|
|
220
357
|
getHistoryPositions(params) {
|
|
221
358
|
return this.getPrivate('api/v1/history-positions', params);
|
|
222
359
|
}
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
360
|
+
/**
|
|
361
|
+
* Get Max Withdraw Margin
|
|
362
|
+
* This interface can query the maximum amount of margin that the current position supports withdrawal.
|
|
363
|
+
*/
|
|
226
364
|
getMaxWithdrawMargin(params) {
|
|
227
365
|
return this.getPrivate('api/v1/margin/maxWithdrawMargin', params);
|
|
228
366
|
}
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
return this.postPrivate('api/v1/position/margin/deposit-margin', params);
|
|
234
|
-
}
|
|
235
|
-
getMarginMode(params) {
|
|
236
|
-
return this.getPrivate('api/v2/position/getMarginMode', params);
|
|
237
|
-
}
|
|
238
|
-
updateMarginMode(params) {
|
|
239
|
-
return this.postPrivate('api/v2/position/changeMarginMode', params);
|
|
240
|
-
}
|
|
367
|
+
/**
|
|
368
|
+
* Get Cross Margin Leverage
|
|
369
|
+
* This interface can query the current symbol’s cross-margin leverage multiple.
|
|
370
|
+
*/
|
|
241
371
|
getCrossMarginLeverage(params) {
|
|
242
372
|
return this.getPrivate('api/v2/getCrossUserLeverage', params);
|
|
243
373
|
}
|
|
374
|
+
/**
|
|
375
|
+
* Modify Cross Margin Leverage
|
|
376
|
+
* This interface can modify the current symbol’s cross-margin leverage multiple.
|
|
377
|
+
*/
|
|
244
378
|
changeCrossMarginLeverage(params) {
|
|
245
379
|
return this.postPrivate('api/v2/changeCrossUserLeverage', params);
|
|
246
380
|
}
|
|
247
381
|
/**
|
|
248
|
-
*
|
|
249
|
-
*
|
|
250
|
-
|
|
382
|
+
* Add Isolated Margin
|
|
383
|
+
* Add Isolated Margin Manually.
|
|
384
|
+
*/
|
|
385
|
+
depositMargin(params) {
|
|
386
|
+
return this.postPrivate('api/v1/position/margin/deposit-margin', params);
|
|
387
|
+
}
|
|
388
|
+
/**
|
|
389
|
+
* Remove Isolated Margin
|
|
390
|
+
* Remove Isolated Margin Manually.
|
|
391
|
+
*/
|
|
392
|
+
withdrawMargin(params) {
|
|
393
|
+
return this.postPrivate('api/v1/margin/withdrawMargin', params);
|
|
394
|
+
}
|
|
395
|
+
/**
|
|
396
|
+
* Get Isolated Margin Risk Limit
|
|
397
|
+
* This interface can be used to obtain information about risk limit level of a specific contract(Only valid for isolated Margin).
|
|
251
398
|
*/
|
|
252
399
|
getRiskLimitLevel(params) {
|
|
253
400
|
return this.getPrivate(`api/v1/contracts/risk-limit/${params.symbol}`);
|
|
254
401
|
}
|
|
402
|
+
/**
|
|
403
|
+
* Modify Isolated Margin Risk Limit
|
|
404
|
+
* This interface is for the adjustment of the risk limit level(Only valid for isolated Margin).
|
|
405
|
+
*/
|
|
255
406
|
updateRiskLimitLevel(params) {
|
|
256
407
|
return this.postPrivate('api/v1/position/risk-limit-level/change', params);
|
|
257
408
|
}
|
|
258
409
|
/**
|
|
259
410
|
*
|
|
260
|
-
* REST -
|
|
411
|
+
* REST - Futures Trading - Funding Fees
|
|
261
412
|
*
|
|
262
413
|
*/
|
|
414
|
+
/**
|
|
415
|
+
* Get Current Funding Rate
|
|
416
|
+
* This interface can be used to obtain the current funding rate of the specified symbol.
|
|
417
|
+
*/
|
|
263
418
|
getFundingRate(params) {
|
|
264
419
|
return this.get(`api/v1/funding-rate/${params.symbol}/current`);
|
|
265
420
|
}
|
|
421
|
+
/**
|
|
422
|
+
* Get Public Funding History
|
|
423
|
+
* Query the funding rate at each settlement time point within a certain time range of the corresponding contract
|
|
424
|
+
*/
|
|
266
425
|
getFundingRates(params) {
|
|
267
426
|
return this.get('api/v1/contract/funding-rates', params);
|
|
268
427
|
}
|
|
428
|
+
/**
|
|
429
|
+
* Get Private Funding History
|
|
430
|
+
* Submit request to get the funding history.
|
|
431
|
+
*/
|
|
269
432
|
getFundingHistory(params) {
|
|
270
433
|
return this.getPrivate('api/v1/funding-history', params);
|
|
271
434
|
}
|
|
@@ -288,6 +451,36 @@ class FuturesClient extends BaseRestClient_js_1.BaseRestClient {
|
|
|
288
451
|
getPrivateWSConnectionToken() {
|
|
289
452
|
return this.postPrivate('api/v1/bullet-private');
|
|
290
453
|
}
|
|
454
|
+
/*
|
|
455
|
+
*
|
|
456
|
+
* DEPRECATED
|
|
457
|
+
*
|
|
458
|
+
*/
|
|
459
|
+
/**
|
|
460
|
+
* @deprecated - please use universal transfer from SpotClient
|
|
461
|
+
*/
|
|
462
|
+
submitTransferOut(params) {
|
|
463
|
+
return this.postPrivate('api/v3/transfer-out', params);
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* @deprecated - please use universal transfer from SpotClient
|
|
467
|
+
*/
|
|
468
|
+
submitTransferIn(params) {
|
|
469
|
+
return this.postPrivate('api/v1/transfer-in', params);
|
|
470
|
+
}
|
|
471
|
+
/**
|
|
472
|
+
* @deprecated - please use universal transfer from SpotClient
|
|
473
|
+
*/
|
|
474
|
+
getTransfers(params) {
|
|
475
|
+
return this.getPrivate('api/v1/transfer-list', params);
|
|
476
|
+
}
|
|
477
|
+
/**
|
|
478
|
+
* @deprecated - please use updateMarginMode() instead
|
|
479
|
+
*/
|
|
480
|
+
updateAutoDepositStatus(params) {
|
|
481
|
+
console.warn('WARNING: This method is deprecated. It is recommended to use cross margin mode instead.');
|
|
482
|
+
return this.postPrivate('api/v1/position/margin/auto-deposit-status', params);
|
|
483
|
+
}
|
|
291
484
|
}
|
|
292
485
|
exports.FuturesClient = FuturesClient;
|
|
293
486
|
//# sourceMappingURL=FuturesClient.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FuturesClient.js","sourceRoot":"","sources":["../../src/FuturesClient.ts"],"names":[],"mappings":";;;AACA,mCAAgC;AAEhC,+DAAyD;AACzD,2DAI+B;
|
|
1
|
+
{"version":3,"file":"FuturesClient.js","sourceRoot":"","sources":["../../src/FuturesClient.ts"],"names":[],"mappings":";;;AACA,mCAAgC;AAEhC,+DAAyD;AACzD,2DAI+B;AAmD/B;;GAEG;AACH,MAAa,aAAc,SAAQ,kCAAc;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,uCAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IAEH,kBAAkB;QAChB,OAAO,IAAA,eAAM,EAAC,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;AA9tBD,sCA8tBC"}
|