ccxt 4.2.36 → 4.2.38

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.
@@ -134,149 +134,149 @@ class bitfinex2 extends bitfinex2$1 {
134
134
  'api': {
135
135
  'public': {
136
136
  'get': {
137
- 'conf/{config}': 2.66,
138
- 'conf/pub:{action}:{object}': 2.66,
139
- 'conf/pub:{action}:{object}:{detail}': 2.66,
140
- 'conf/pub:map:{object}': 2.66,
141
- 'conf/pub:map:{object}:{detail}': 2.66,
142
- 'conf/pub:map:currency:{detail}': 2.66,
143
- 'conf/pub:map:currency:sym': 2.66,
144
- 'conf/pub:map:currency:label': 2.66,
145
- 'conf/pub:map:currency:unit': 2.66,
146
- 'conf/pub:map:currency:undl': 2.66,
147
- 'conf/pub:map:currency:pool': 2.66,
148
- 'conf/pub:map:currency:explorer': 2.66,
149
- 'conf/pub:map:currency:tx:fee': 2.66,
150
- 'conf/pub:map:tx:method': 2.66,
151
- 'conf/pub:list:{object}': 2.66,
152
- 'conf/pub:list:{object}:{detail}': 2.66,
153
- 'conf/pub:list:currency': 2.66,
154
- 'conf/pub:list:pair:exchange': 2.66,
155
- 'conf/pub:list:pair:margin': 2.66,
156
- 'conf/pub:list:pair:futures': 2.66,
157
- 'conf/pub:list:competitions': 2.66,
158
- 'conf/pub:info:{object}': 2.66,
159
- 'conf/pub:info:{object}:{detail}': 2.66,
160
- 'conf/pub:info:pair': 2.66,
161
- 'conf/pub:info:pair:futures': 2.66,
162
- 'conf/pub:info:tx:status': 2.66,
163
- 'conf/pub:fees': 2.66,
137
+ 'conf/{config}': 2.7,
138
+ 'conf/pub:{action}:{object}': 2.7,
139
+ 'conf/pub:{action}:{object}:{detail}': 2.7,
140
+ 'conf/pub:map:{object}': 2.7,
141
+ 'conf/pub:map:{object}:{detail}': 2.7,
142
+ 'conf/pub:map:currency:{detail}': 2.7,
143
+ 'conf/pub:map:currency:sym': 2.7,
144
+ 'conf/pub:map:currency:label': 2.7,
145
+ 'conf/pub:map:currency:unit': 2.7,
146
+ 'conf/pub:map:currency:undl': 2.7,
147
+ 'conf/pub:map:currency:pool': 2.7,
148
+ 'conf/pub:map:currency:explorer': 2.7,
149
+ 'conf/pub:map:currency:tx:fee': 2.7,
150
+ 'conf/pub:map:tx:method': 2.7,
151
+ 'conf/pub:list:{object}': 2.7,
152
+ 'conf/pub:list:{object}:{detail}': 2.7,
153
+ 'conf/pub:list:currency': 2.7,
154
+ 'conf/pub:list:pair:exchange': 2.7,
155
+ 'conf/pub:list:pair:margin': 2.7,
156
+ 'conf/pub:list:pair:futures': 2.7,
157
+ 'conf/pub:list:competitions': 2.7,
158
+ 'conf/pub:info:{object}': 2.7,
159
+ 'conf/pub:info:{object}:{detail}': 2.7,
160
+ 'conf/pub:info:pair': 2.7,
161
+ 'conf/pub:info:pair:futures': 2.7,
162
+ 'conf/pub:info:tx:status': 2.7,
163
+ 'conf/pub:fees': 2.7,
164
164
  'platform/status': 8,
165
- 'tickers': 2.66,
166
- 'ticker/{symbol}': 2.66,
167
- 'tickers/hist': 2.66,
168
- 'trades/{symbol}/hist': 2.66,
165
+ 'tickers': 2.7,
166
+ 'ticker/{symbol}': 2.7,
167
+ 'tickers/hist': 2.7,
168
+ 'trades/{symbol}/hist': 2.7,
169
169
  'book/{symbol}/{precision}': 1,
170
170
  'book/{symbol}/P0': 1,
171
171
  'book/{symbol}/P1': 1,
172
172
  'book/{symbol}/P2': 1,
173
173
  'book/{symbol}/P3': 1,
174
174
  'book/{symbol}/R0': 1,
175
- 'stats1/{key}:{size}:{symbol}:{side}/{section}': 2.66,
176
- 'stats1/{key}:{size}:{symbol}:{side}/last': 2.66,
177
- 'stats1/{key}:{size}:{symbol}:{side}/hist': 2.66,
178
- 'stats1/{key}:{size}:{symbol}/{section}': 2.66,
179
- 'stats1/{key}:{size}:{symbol}/last': 2.66,
180
- 'stats1/{key}:{size}:{symbol}/hist': 2.66,
181
- 'stats1/{key}:{size}:{symbol}:long/last': 2.66,
182
- 'stats1/{key}:{size}:{symbol}:long/hist': 2.66,
183
- 'stats1/{key}:{size}:{symbol}:short/last': 2.66,
184
- 'stats1/{key}:{size}:{symbol}:short/hist': 2.66,
185
- 'candles/trade:{timeframe}:{symbol}:{period}/{section}': 2.66,
186
- 'candles/trade:{timeframe}:{symbol}/{section}': 2.66,
187
- 'candles/trade:{timeframe}:{symbol}/last': 2.66,
188
- 'candles/trade:{timeframe}:{symbol}/hist': 2.66,
189
- 'status/{type}': 2.66,
190
- 'status/deriv': 2.66,
191
- 'status/deriv/{symbol}/hist': 2.66,
175
+ 'stats1/{key}:{size}:{symbol}:{side}/{section}': 2.7,
176
+ 'stats1/{key}:{size}:{symbol}:{side}/last': 2.7,
177
+ 'stats1/{key}:{size}:{symbol}:{side}/hist': 2.7,
178
+ 'stats1/{key}:{size}:{symbol}/{section}': 2.7,
179
+ 'stats1/{key}:{size}:{symbol}/last': 2.7,
180
+ 'stats1/{key}:{size}:{symbol}/hist': 2.7,
181
+ 'stats1/{key}:{size}:{symbol}:long/last': 2.7,
182
+ 'stats1/{key}:{size}:{symbol}:long/hist': 2.7,
183
+ 'stats1/{key}:{size}:{symbol}:short/last': 2.7,
184
+ 'stats1/{key}:{size}:{symbol}:short/hist': 2.7,
185
+ 'candles/trade:{timeframe}:{symbol}:{period}/{section}': 2.7,
186
+ 'candles/trade:{timeframe}:{symbol}/{section}': 2.7,
187
+ 'candles/trade:{timeframe}:{symbol}/last': 2.7,
188
+ 'candles/trade:{timeframe}:{symbol}/hist': 2.7,
189
+ 'status/{type}': 2.7,
190
+ 'status/deriv': 2.7,
191
+ 'status/deriv/{symbol}/hist': 2.7,
192
192
  'liquidations/hist': 80,
193
- 'rankings/{key}:{timeframe}:{symbol}/{section}': 2.66,
194
- 'rankings/{key}:{timeframe}:{symbol}/hist': 2.66,
195
- 'pulse/hist': 2.66,
196
- 'pulse/profile/{nickname}': 2.66,
193
+ 'rankings/{key}:{timeframe}:{symbol}/{section}': 2.7,
194
+ 'rankings/{key}:{timeframe}:{symbol}/hist': 2.7,
195
+ 'pulse/hist': 2.7,
196
+ 'pulse/profile/{nickname}': 2.7,
197
197
  'funding/stats/{symbol}/hist': 10, // ratelimit not in docs
198
198
  },
199
199
  'post': {
200
- 'calc/trade/avg': 2.66,
201
- 'calc/fx': 2.66,
200
+ 'calc/trade/avg': 2.7,
201
+ 'calc/fx': 2.7,
202
202
  },
203
203
  },
204
204
  'private': {
205
205
  'post': {
206
206
  // 'auth/r/orders/{symbol}/new', // outdated
207
207
  // 'auth/r/stats/perf:{timeframe}/hist', // outdated
208
- 'auth/r/wallets': 2.66,
209
- 'auth/r/wallets/hist': 2.66,
210
- 'auth/r/orders': 2.66,
211
- 'auth/r/orders/{symbol}': 2.66,
212
- 'auth/w/order/submit': 2.66,
213
- 'auth/w/order/update': 2.66,
214
- 'auth/w/order/cancel': 2.66,
215
- 'auth/w/order/multi': 2.66,
216
- 'auth/w/order/cancel/multi': 2.66,
217
- 'auth/r/orders/{symbol}/hist': 2.66,
218
- 'auth/r/orders/hist': 2.66,
219
- 'auth/r/order/{symbol}:{id}/trades': 2.66,
220
- 'auth/r/trades/{symbol}/hist': 2.66,
221
- 'auth/r/trades/hist': 2.66,
222
- 'auth/r/ledgers/{currency}/hist': 2.66,
223
- 'auth/r/ledgers/hist': 2.66,
224
- 'auth/r/info/margin/{key}': 2.66,
225
- 'auth/r/info/margin/base': 2.66,
226
- 'auth/r/info/margin/sym_all': 2.66,
227
- 'auth/r/positions': 2.66,
228
- 'auth/w/position/claim': 2.66,
229
- 'auth/w/position/increase:': 2.66,
230
- 'auth/r/position/increase/info': 2.66,
231
- 'auth/r/positions/hist': 2.66,
232
- 'auth/r/positions/audit': 2.66,
233
- 'auth/r/positions/snap': 2.66,
234
- 'auth/w/deriv/collateral/set': 2.66,
235
- 'auth/w/deriv/collateral/limits': 2.66,
236
- 'auth/r/funding/offers': 2.66,
237
- 'auth/r/funding/offers/{symbol}': 2.66,
238
- 'auth/w/funding/offer/submit': 2.66,
239
- 'auth/w/funding/offer/cancel': 2.66,
240
- 'auth/w/funding/offer/cancel/all': 2.66,
241
- 'auth/w/funding/close': 2.66,
242
- 'auth/w/funding/auto': 2.66,
243
- 'auth/w/funding/keep': 2.66,
244
- 'auth/r/funding/offers/{symbol}/hist': 2.66,
245
- 'auth/r/funding/offers/hist': 2.66,
246
- 'auth/r/funding/loans': 2.66,
247
- 'auth/r/funding/loans/hist': 2.66,
248
- 'auth/r/funding/loans/{symbol}': 2.66,
249
- 'auth/r/funding/loans/{symbol}/hist': 2.66,
250
- 'auth/r/funding/credits': 2.66,
251
- 'auth/r/funding/credits/hist': 2.66,
252
- 'auth/r/funding/credits/{symbol}': 2.66,
253
- 'auth/r/funding/credits/{symbol}/hist': 2.66,
254
- 'auth/r/funding/trades/{symbol}/hist': 2.66,
255
- 'auth/r/funding/trades/hist': 2.66,
256
- 'auth/r/info/funding/{key}': 2.66,
257
- 'auth/r/info/user': 2.66,
258
- 'auth/r/summary': 2.66,
259
- 'auth/r/logins/hist': 2.66,
260
- 'auth/r/permissions': 2.66,
261
- 'auth/w/token': 2.66,
262
- 'auth/r/audit/hist': 2.66,
263
- 'auth/w/transfer': 2.66,
208
+ 'auth/r/wallets': 2.7,
209
+ 'auth/r/wallets/hist': 2.7,
210
+ 'auth/r/orders': 2.7,
211
+ 'auth/r/orders/{symbol}': 2.7,
212
+ 'auth/w/order/submit': 2.7,
213
+ 'auth/w/order/update': 2.7,
214
+ 'auth/w/order/cancel': 2.7,
215
+ 'auth/w/order/multi': 2.7,
216
+ 'auth/w/order/cancel/multi': 2.7,
217
+ 'auth/r/orders/{symbol}/hist': 2.7,
218
+ 'auth/r/orders/hist': 2.7,
219
+ 'auth/r/order/{symbol}:{id}/trades': 2.7,
220
+ 'auth/r/trades/{symbol}/hist': 2.7,
221
+ 'auth/r/trades/hist': 2.7,
222
+ 'auth/r/ledgers/{currency}/hist': 2.7,
223
+ 'auth/r/ledgers/hist': 2.7,
224
+ 'auth/r/info/margin/{key}': 2.7,
225
+ 'auth/r/info/margin/base': 2.7,
226
+ 'auth/r/info/margin/sym_all': 2.7,
227
+ 'auth/r/positions': 2.7,
228
+ 'auth/w/position/claim': 2.7,
229
+ 'auth/w/position/increase:': 2.7,
230
+ 'auth/r/position/increase/info': 2.7,
231
+ 'auth/r/positions/hist': 2.7,
232
+ 'auth/r/positions/audit': 2.7,
233
+ 'auth/r/positions/snap': 2.7,
234
+ 'auth/w/deriv/collateral/set': 2.7,
235
+ 'auth/w/deriv/collateral/limits': 2.7,
236
+ 'auth/r/funding/offers': 2.7,
237
+ 'auth/r/funding/offers/{symbol}': 2.7,
238
+ 'auth/w/funding/offer/submit': 2.7,
239
+ 'auth/w/funding/offer/cancel': 2.7,
240
+ 'auth/w/funding/offer/cancel/all': 2.7,
241
+ 'auth/w/funding/close': 2.7,
242
+ 'auth/w/funding/auto': 2.7,
243
+ 'auth/w/funding/keep': 2.7,
244
+ 'auth/r/funding/offers/{symbol}/hist': 2.7,
245
+ 'auth/r/funding/offers/hist': 2.7,
246
+ 'auth/r/funding/loans': 2.7,
247
+ 'auth/r/funding/loans/hist': 2.7,
248
+ 'auth/r/funding/loans/{symbol}': 2.7,
249
+ 'auth/r/funding/loans/{symbol}/hist': 2.7,
250
+ 'auth/r/funding/credits': 2.7,
251
+ 'auth/r/funding/credits/hist': 2.7,
252
+ 'auth/r/funding/credits/{symbol}': 2.7,
253
+ 'auth/r/funding/credits/{symbol}/hist': 2.7,
254
+ 'auth/r/funding/trades/{symbol}/hist': 2.7,
255
+ 'auth/r/funding/trades/hist': 2.7,
256
+ 'auth/r/info/funding/{key}': 2.7,
257
+ 'auth/r/info/user': 2.7,
258
+ 'auth/r/summary': 2.7,
259
+ 'auth/r/logins/hist': 2.7,
260
+ 'auth/r/permissions': 2.7,
261
+ 'auth/w/token': 2.7,
262
+ 'auth/r/audit/hist': 2.7,
263
+ 'auth/w/transfer': 2.7,
264
264
  'auth/w/deposit/address': 24,
265
265
  'auth/w/deposit/invoice': 24,
266
266
  'auth/w/withdraw': 24,
267
- 'auth/r/movements/{currency}/hist': 2.66,
268
- 'auth/r/movements/hist': 2.66,
269
- 'auth/r/alerts': 5.33,
270
- 'auth/w/alert/set': 2.66,
271
- 'auth/w/alert/price:{symbol}:{price}/del': 2.66,
272
- 'auth/w/alert/{type}:{symbol}:{price}/del': 2.66,
273
- 'auth/calc/order/avail': 2.66,
274
- 'auth/w/settings/set': 2.66,
275
- 'auth/r/settings': 2.66,
276
- 'auth/w/settings/del': 2.66,
277
- 'auth/r/pulse/hist': 2.66,
267
+ 'auth/r/movements/{currency}/hist': 2.7,
268
+ 'auth/r/movements/hist': 2.7,
269
+ 'auth/r/alerts': 5.34,
270
+ 'auth/w/alert/set': 2.7,
271
+ 'auth/w/alert/price:{symbol}:{price}/del': 2.7,
272
+ 'auth/w/alert/{type}:{symbol}:{price}/del': 2.7,
273
+ 'auth/calc/order/avail': 2.7,
274
+ 'auth/w/settings/set': 2.7,
275
+ 'auth/r/settings': 2.7,
276
+ 'auth/w/settings/del': 2.7,
277
+ 'auth/r/pulse/hist': 2.7,
278
278
  'auth/w/pulse/add': 16,
279
- 'auth/w/pulse/del': 2.66,
279
+ 'auth/w/pulse/del': 2.7,
280
280
  },
281
281
  },
282
282
  },
@@ -282,6 +282,7 @@ class bitmex extends bitmex$1 {
282
282
  * @method
283
283
  * @name bitmex#fetchCurrencies
284
284
  * @description fetches all available currencies on an exchange
285
+ * @see https://www.bitmex.com/api/explorer/#!/Wallet/Wallet_getAssetsConfig
285
286
  * @param {object} [params] extra parameters specific to the exchange API endpoint
286
287
  * @returns {object} an associative dictionary of currencies
287
288
  */
@@ -767,6 +768,7 @@ class bitmex extends bitmex$1 {
767
768
  * @method
768
769
  * @name bitmex#fetchBalance
769
770
  * @description query for balance and get the amount of funds available for trading or funds locked in orders
771
+ * @see https://www.bitmex.com/api/explorer/#!/User/User_getMargin
770
772
  * @param {object} [params] extra parameters specific to the exchange API endpoint
771
773
  * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
772
774
  */
@@ -829,6 +831,7 @@ class bitmex extends bitmex$1 {
829
831
  * @method
830
832
  * @name bitmex#fetchOrderBook
831
833
  * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
834
+ * @see https://www.bitmex.com/api/explorer/#!/OrderBook/OrderBook_getL2
832
835
  * @param {string} symbol unified symbol of the market to fetch the order book for
833
836
  * @param {int} [limit] the maximum amount of order book entries to return
834
837
  * @param {object} [params] extra parameters specific to the exchange API endpoint
@@ -872,6 +875,7 @@ class bitmex extends bitmex$1 {
872
875
  * @method
873
876
  * @name bitmex#fetchOrder
874
877
  * @description fetches information on an order made by the user
878
+ * @see https://www.bitmex.com/api/explorer/#!/Order/Order_getOrders
875
879
  * @param {string} symbol unified symbol of the market the order was made in
876
880
  * @param {object} [params] extra parameters specific to the exchange API endpoint
877
881
  * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
@@ -940,6 +944,7 @@ class bitmex extends bitmex$1 {
940
944
  * @method
941
945
  * @name bitmex#fetchOpenOrders
942
946
  * @description fetch all unfilled currently open orders
947
+ * @see https://www.bitmex.com/api/explorer/#!/Order/Order_getOrders
943
948
  * @param {string} symbol unified market symbol
944
949
  * @param {int} [since] the earliest time in ms to fetch open orders for
945
950
  * @param {int} [limit] the maximum number of open orders structures to retrieve
@@ -958,6 +963,7 @@ class bitmex extends bitmex$1 {
958
963
  * @method
959
964
  * @name bitmex#fetchClosedOrders
960
965
  * @description fetches information on multiple closed orders made by the user
966
+ * @see https://www.bitmex.com/api/explorer/#!/Order/Order_getOrders
961
967
  * @param {string} symbol unified market symbol of the market orders were made in
962
968
  * @param {int} [since] the earliest time in ms to fetch orders for
963
969
  * @param {int} [limit] the maximum number of order structures to retrieve
@@ -972,8 +978,8 @@ class bitmex extends bitmex$1 {
972
978
  /**
973
979
  * @method
974
980
  * @name bitmex#fetchMyTrades
975
- * @see https://www.bitmex.com/api/explorer/#!/Execution/Execution_getTradeHistory
976
981
  * @description fetch all trades made by the user
982
+ * @see https://www.bitmex.com/api/explorer/#!/Execution/Execution_getTradeHistory
977
983
  * @param {string} symbol unified market symbol
978
984
  * @param {int} [since] the earliest time in ms to fetch trades for
979
985
  * @param {int} [limit] the maximum number of trades structures to retrieve
@@ -1182,6 +1188,7 @@ class bitmex extends bitmex$1 {
1182
1188
  * @method
1183
1189
  * @name bitmex#fetchLedger
1184
1190
  * @description fetch the history of changes, actions done by the user or operations that altered balance of the user
1191
+ * @see https://www.bitmex.com/api/explorer/#!/User/User_getWalletHistory
1185
1192
  * @param {string} code unified currency code, default is undefined
1186
1193
  * @param {int} [since] timestamp in ms of the earliest ledger entry, default is undefined
1187
1194
  * @param {int} [limit] max number of ledger entrys to return, default is undefined
@@ -1233,6 +1240,7 @@ class bitmex extends bitmex$1 {
1233
1240
  * @method
1234
1241
  * @name bitmex#fetchDepositsWithdrawals
1235
1242
  * @description fetch history of deposits and withdrawals
1243
+ * @see https://www.bitmex.com/api/explorer/#!/User/User_getWalletHistory
1236
1244
  * @param {string} [code] unified currency code for the currency of the deposit/withdrawals, default is undefined
1237
1245
  * @param {int} [since] timestamp in ms of the earliest deposit/withdrawal, default is undefined
1238
1246
  * @param {int} [limit] max number of deposit/withdrawals to return, default is undefined
@@ -1351,6 +1359,7 @@ class bitmex extends bitmex$1 {
1351
1359
  * @method
1352
1360
  * @name bitmex#fetchTicker
1353
1361
  * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
1362
+ * @see https://www.bitmex.com/api/explorer/#!/Instrument/Instrument_get
1354
1363
  * @param {string} symbol unified symbol of the market to fetch the ticker for
1355
1364
  * @param {object} [params] extra parameters specific to the exchange API endpoint
1356
1365
  * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
@@ -1372,6 +1381,7 @@ class bitmex extends bitmex$1 {
1372
1381
  * @method
1373
1382
  * @name bitmex#fetchTickers
1374
1383
  * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
1384
+ * @see https://www.bitmex.com/api/explorer/#!/Instrument/Instrument_getActiveAndIndices
1375
1385
  * @param {string[]|undefined} symbols unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
1376
1386
  * @param {object} [params] extra parameters specific to the exchange API endpoint
1377
1387
  * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
@@ -1454,8 +1464,8 @@ class bitmex extends bitmex$1 {
1454
1464
  /**
1455
1465
  * @method
1456
1466
  * @name bitmex#fetchOHLCV
1457
- * @see https://www.bitmex.com/api/explorer/#!/Trade/Trade_getBucketed
1458
1467
  * @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
1468
+ * @see https://www.bitmex.com/api/explorer/#!/Trade/Trade_getBucketed
1459
1469
  * @param {string} symbol unified symbol of the market to fetch OHLCV data for
1460
1470
  * @param {string} timeframe the length of time each candle represents
1461
1471
  * @param {int} [since] timestamp in ms of the earliest candle to fetch
@@ -1770,8 +1780,8 @@ class bitmex extends bitmex$1 {
1770
1780
  /**
1771
1781
  * @method
1772
1782
  * @name bitmex#fetchTrades
1773
- * @see https://www.bitmex.com/api/explorer/#!/Trade/Trade_get
1774
1783
  * @description get the list of most recent trades for a particular symbol
1784
+ * @see https://www.bitmex.com/api/explorer/#!/Trade/Trade_get
1775
1785
  * @param {string} symbol unified symbol of the market to fetch trades for
1776
1786
  * @param {int} [since] timestamp in ms of the earliest trade to fetch
1777
1787
  * @param {int} [limit] the maximum amount of trades to fetch
@@ -1992,6 +2002,7 @@ class bitmex extends bitmex$1 {
1992
2002
  * @method
1993
2003
  * @name bitmex#cancelOrder
1994
2004
  * @description cancels an open order
2005
+ * @see https://www.bitmex.com/api/explorer/#!/Order/Order_cancel
1995
2006
  * @param {string} id order id
1996
2007
  * @param {string} symbol not used by bitmex cancelOrder ()
1997
2008
  * @param {object} [params] extra parameters specific to the exchange API endpoint
@@ -2023,6 +2034,7 @@ class bitmex extends bitmex$1 {
2023
2034
  * @method
2024
2035
  * @name bitmex#cancelOrders
2025
2036
  * @description cancel multiple orders
2037
+ * @see https://www.bitmex.com/api/explorer/#!/Order/Order_cancel
2026
2038
  * @param {string[]} ids order ids
2027
2039
  * @param {string} symbol not used by bitmex cancelOrders ()
2028
2040
  * @param {object} [params] extra parameters specific to the exchange API endpoint
@@ -2048,6 +2060,7 @@ class bitmex extends bitmex$1 {
2048
2060
  * @method
2049
2061
  * @name bitmex#cancelAllOrders
2050
2062
  * @description cancel all open orders
2063
+ * @see https://www.bitmex.com/api/explorer/#!/Order/Order_cancelAll
2051
2064
  * @param {string} symbol unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
2052
2065
  * @param {object} [params] extra parameters specific to the exchange API endpoint
2053
2066
  * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
@@ -2106,6 +2119,7 @@ class bitmex extends bitmex$1 {
2106
2119
  * @method
2107
2120
  * @name bitmex#fetchPositions
2108
2121
  * @description fetch all open positions
2122
+ * @see https://www.bitmex.com/api/explorer/#!/Position/Position_get
2109
2123
  * @param {string[]|undefined} symbols list of unified market symbols
2110
2124
  * @param {object} [params] extra parameters specific to the exchange API endpoint
2111
2125
  * @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/#/?id=position-structure}
@@ -2364,6 +2378,7 @@ class bitmex extends bitmex$1 {
2364
2378
  * @method
2365
2379
  * @name bitmex#withdraw
2366
2380
  * @description make a withdrawal
2381
+ * @see https://www.bitmex.com/api/explorer/#!/User/User_requestWithdrawal
2367
2382
  * @param {string} code unified currency code
2368
2383
  * @param {float} amount the amount to withdraw
2369
2384
  * @param {string} address the address to withdraw to
@@ -2411,6 +2426,7 @@ class bitmex extends bitmex$1 {
2411
2426
  * @method
2412
2427
  * @name bitmex#fetchFundingRates
2413
2428
  * @description fetch the funding rate for multiple markets
2429
+ * @see https://www.bitmex.com/api/explorer/#!/Instrument/Instrument_getActiveAndIndices
2414
2430
  * @param {string[]|undefined} symbols list of unified market symbols
2415
2431
  * @param {object} [params] extra parameters specific to the exchange API endpoint
2416
2432
  * @returns {object} a dictionary of [funding rates structures]{@link https://docs.ccxt.com/#/?id=funding-rates-structure}, indexe by market symbols
@@ -2462,6 +2478,7 @@ class bitmex extends bitmex$1 {
2462
2478
  * @method
2463
2479
  * @name bitmex#fetchFundingRateHistory
2464
2480
  * @description Fetches the history of funding rates
2481
+ * @see https://www.bitmex.com/api/explorer/#!/Funding/Funding_get
2465
2482
  * @param {string} symbol unified symbol of the market to fetch the funding rate history for
2466
2483
  * @param {int} [since] timestamp in ms of the earliest funding rate to fetch
2467
2484
  * @param {int} [limit] the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure} to fetch
@@ -2545,6 +2562,7 @@ class bitmex extends bitmex$1 {
2545
2562
  * @method
2546
2563
  * @name bitmex#setLeverage
2547
2564
  * @description set the level of leverage for a market
2565
+ * @see https://www.bitmex.com/api/explorer/#!/Position/Position_updateLeverage
2548
2566
  * @param {float} leverage the rate of leverage
2549
2567
  * @param {string} symbol unified market symbol
2550
2568
  * @param {object} [params] extra parameters specific to the exchange API endpoint
@@ -2572,6 +2590,7 @@ class bitmex extends bitmex$1 {
2572
2590
  * @method
2573
2591
  * @name bitmex#setMarginMode
2574
2592
  * @description set margin mode to 'cross' or 'isolated'
2593
+ * @see https://www.bitmex.com/api/explorer/#!/Position/Position_isolateMargin
2575
2594
  * @param {string} marginMode 'cross' or 'isolated'
2576
2595
  * @param {string} symbol unified market symbol
2577
2596
  * @param {object} [params] extra parameters specific to the exchange API endpoint