ccxt 4.1.56 → 4.1.58

package/js/src/bitmex.js

@@ -393,9 +393,7 @@ export default class bitmex extends Exchange {
     convertToRealAmount(code, amount) {
         const currency = this.currency(code);
         const precision = this.safeString(currency, 'precision');
-        const amountString = this.numberToString(amount);
-        const finalAmount = Precise.stringMul(amountString, precision);
-        return this.parseNumber(finalAmount);
+        return Precise.stringMul(amount, precision);
     }
     amountToPrecision(symbol, amount) {
         symbol = this.safeSymbol(symbol);
@@ -417,7 +415,7 @@ export default class bitmex extends Exchange {
         }
         const market = this.market(symbol);
         if (market['spot']) {
-            return this.convertToRealAmount(market[currencySide], rawQuantity);
+            return this.parseNumber(this.convertToRealAmount(market[currencySide], rawQuantity));
         }
         return this.parseNumber(rawQuantity);
     }
@@ -432,7 +430,7 @@ export default class bitmex extends Exchange {
          * @param {object} [params] extra parameters specific to the exchange api endpoint
          * @returns {object[]} an array of objects representing market data
          */
-        const response = await this.publicGetInstrumentActiveAndIndices(params);
+        const response = await this.publicGetInstrumentActive(params);
         //
         //  [
         //    {
@@ -548,30 +546,38 @@ export default class bitmex extends Exchange {
     }
     parseMarket(market) {
         const id = this.safeString(market, 'symbol');
-        const baseId = this.safeString(market, 'underlying');
-        const quoteId = this.safeString(market, 'quoteCurrency');
+        let baseId = this.safeString(market, 'underlying');
+        let quoteId = this.safeString(market, 'quoteCurrency');
         const settleId = this.safeString(market, 'settlCurrency');
-        const base = this.safeCurrencyCode(baseId);
-        const quote = this.safeCurrencyCode(quoteId);
         const settle = this.safeCurrencyCode(settleId);
         // 'positionCurrency' may be empty ("", as Bitmex currently returns for ETHUSD)
         // so let's take the settlCurrency first and then adjust if needed
         const typ = this.safeString(market, 'typ'); // type definitions at: https://www.bitmex.com/api/explorer/#!/Instrument/Instrument_get
-        const types = {
-            'FFWCSX': 'swap',
-            'FFWCSF': 'swap',
-            'IFXXXP': 'spot',
-            'FFCCSX': 'future',
-            'MRBXXX': 'index',
-            'MRCXXX': 'index',
-            'MRFXXX': 'index',
-            'MRRXXX': 'index',
-            'MRIXXX': 'index',
-        };
-        const type = this.safeString(types, typ, typ);
-        const swap = type === 'swap';
-        const future = type === 'future';
-        const spot = type === 'spot';
+        let type;
+        let swap = false;
+        let spot = false;
+        let future = false;
+        if (typ === 'FFWCSX') {
+            type = 'swap';
+            swap = true;
+        }
+        else if (typ === 'IFXXXP') {
+            type = 'spot';
+            spot = true;
+        }
+        else if (typ === 'FFCCSX') {
+            type = 'future';
+            future = true;
+        }
+        else if (typ === 'FFICSX') {
+            // prediction markets (without any volume)
+            quoteId = baseId;
+            baseId = this.safeString(market, 'rootSymbol');
+            type = 'future';
+            future = true;
+        }
+        const base = this.safeCurrencyCode(baseId);
+        const quote = this.safeCurrencyCode(quoteId);
         const contract = swap || future;
         let contractSize = undefined;
         const isInverse = this.safeValue(market, 'isInverse'); // this is true when BASE and SETTLE are same, i.e. BTC/XXX:BTC
@@ -587,11 +593,12 @@ export default class bitmex extends Exchange {
         }
         else if (contract) {
             symbol = base + '/' + quote + ':' + settle;
-            const multiplierString = Precise.stringAbs(this.safeString(market, 'multiplier'));
             if (linear) {
-                contractSize = this.parseNumber(Precise.stringDiv('1', market['underlyingToPositionMultiplier']));
+                const multiplierString = this.safeString2(market, 'underlyingToPositionMultiplier', 'underlyingToSettleMultiplier');
+                contractSize = this.parseNumber(Precise.stringDiv('1', multiplierString));
             }
             else {
+                const multiplierString = Precise.stringAbs(this.safeString(market, 'multiplier'));
                 contractSize = this.parseNumber(multiplierString);
             }
             if (future) {
@@ -731,7 +738,7 @@ export default class bitmex extends Exchange {
          * @name bitmex#fetchBalance
          * @description query for balance and get the amount of funds available for trading or funds locked in orders
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} a [balance structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#balance-structure}
+         * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
          */
         await this.loadMarkets();
         const request = {
@@ -795,7 +802,7 @@ export default class bitmex extends Exchange {
          * @param {string} symbol unified symbol of the market to fetch the order book for
          * @param {int} [limit] the maximum amount of order book entries to return
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} A dictionary of [order book structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-book-structure} indexed by market symbols
+         * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
          */
         await this.loadMarkets();
         const market = this.market(symbol);
@@ -837,7 +844,7 @@ export default class bitmex extends Exchange {
          * @description fetches information on an order made by the user
          * @param {string} symbol unified symbol of the market the order was made in
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} An [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+         * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
          */
         const filter = {
             'filter': {
@@ -863,7 +870,7 @@ export default class bitmex extends Exchange {
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
          * @param {int} [params.until] the earliest time in ms to fetch orders for
          * @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
-         * @returns {Order[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+         * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
          */
         await this.loadMarkets();
         let paginate = false;
@@ -907,7 +914,7 @@ export default class bitmex extends Exchange {
          * @param {int} [since] the earliest time in ms to fetch open orders for
          * @param {int} [limit] the maximum number of  open orders structures to retrieve
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {Order[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+         * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
          */
         const request = {
             'filter': {
@@ -925,7 +932,7 @@ export default class bitmex extends Exchange {
          * @param {int} [since] the earliest time in ms to fetch orders for
          * @param {int} [limit] the maximum number of  orde structures to retrieve
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {Order[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+         * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
          */
         // Bitmex barfs if you set 'open': false in the filter...
         const orders = await this.fetchOrders(symbol, since, limit, params);
@@ -942,7 +949,7 @@ export default class bitmex extends Exchange {
          * @param {int} [limit] the maximum number of trades structures to retrieve
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
          * @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
-         * @returns {Trade[]} a list of [trade structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#trade-structure}
+         * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
          */
         await this.loadMarkets();
         let paginate = false;
@@ -1100,15 +1107,15 @@ export default class bitmex extends Exchange {
             // for unrealized pnl and other transactions without a timestamp
             timestamp = 0; // see comments above
         }
-        let feeCost = this.safeNumber(item, 'fee', 0);
+        let feeCost = this.safeString(item, 'fee');
         if (feeCost !== undefined) {
             feeCost = this.convertToRealAmount(code, feeCost);
         }
         const fee = {
-            'cost': feeCost,
+            'cost': this.parseNumber(feeCost),
             'currency': code,
         };
-        let after = this.safeNumber(item, 'walletBalance');
+        let after = this.safeString(item, 'walletBalance');
         if (after !== undefined) {
             after = this.convertToRealAmount(code, after);
         }
@@ -1135,7 +1142,7 @@ export default class bitmex extends Exchange {
             'currency': code,
             'amount': amount,
             'before': before,
-            'after': after,
+            'after': this.parseNumber(after),
             'status': status,
             'fee': fee,
         };
@@ -1149,7 +1156,7 @@ export default class bitmex extends Exchange {
          * @param {int} [since] timestamp in ms of the earliest ledger entry, default is undefined
          * @param {int} [limit] max number of ledger entrys to return, default is undefined
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} a [ledger structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#ledger-structure}
+         * @returns {object} a [ledger structure]{@link https://docs.ccxt.com/#/?id=ledger-structure}
          */
         await this.loadMarkets();
         const request = {
@@ -1200,7 +1207,7 @@ export default class bitmex extends Exchange {
          * @param {int} [since] timestamp in ms of the earliest deposit/withdrawal, default is undefined
          * @param {int} [limit] max number of deposit/withdrawals to return, default is undefined
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} a list of [transaction structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#transaction-structure}
+         * @returns {object} a list of [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
          */
         await this.loadMarkets();
         const request = {
@@ -1289,7 +1296,7 @@ export default class bitmex extends Exchange {
             'type': type,
             'currency': currency['code'],
             'network': this.networkIdToCode(this.safeString(transaction, 'network'), currency['code']),
-            'amount': amount,
+            'amount': this.parseNumber(amount),
             'status': status,
             'timestamp': transactTime,
             'datetime': this.iso8601(transactTime),
@@ -1304,7 +1311,7 @@ export default class bitmex extends Exchange {
             'comment': undefined,
             'fee': {
                 'currency': currency['code'],
-                'cost': feeCost,
+                'cost': this.parseNumber(feeCost),
                 'rate': undefined,
             },
         };
@@ -1316,7 +1323,7 @@ export default class bitmex extends Exchange {
          * @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
          * @param {string} symbol unified symbol of the market to fetch the ticker for
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} a [ticker structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure}
+         * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
          */
         await this.loadMarkets();
         const market = this.market(symbol);
@@ -1337,7 +1344,7 @@ export default class bitmex extends Exchange {
          * @description fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
          * @param {string[]|undefined} symbols unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} a dictionary of [ticker structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure}
+         * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
          */
         await this.loadMarkets();
         symbols = this.marketSymbols(symbols);
@@ -1742,7 +1749,7 @@ export default class bitmex extends Exchange {
          * @param {int} [limit] the maximum amount of trades to fetch
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
          * @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
-         * @returns {Trade[]} a list of [trade structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#public-trades}
+         * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
          */
         await this.loadMarkets();
         let paginate = false;
@@ -1805,12 +1812,15 @@ export default class bitmex extends Exchange {
          * @method
          * @name bitmex#createOrder
          * @description create a trade order
+         * @see https://www.bitmex.com/api/explorer/#!/Order/Order_new
          * @param {string} symbol unified symbol of the market to create an order in
          * @param {string} type 'market' or 'limit'
          * @param {string} side 'buy' or 'sell'
          * @param {float} amount how much of currency you want to trade in units of base currency
          * @param {float} [price] the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
+         * @param {object} [params.triggerPrice] the price at which a trigger order is triggered at
+         * @param {object} [params.triggerDirection] the direction whenever the trigger happens with relation to price - 'above' or 'below'
          * @returns {object} an [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
          */
         await this.loadMarkets();
@@ -1831,15 +1841,41 @@ export default class bitmex extends Exchange {
             'ordType': orderType,
             'text': brokerId,
         };
-        if ((orderType === 'Stop') || (orderType === 'StopLimit') || (orderType === 'MarketIfTouched') || (orderType === 'LimitIfTouched')) {
-            const stopPrice = this.safeNumber2(params, 'stopPx', 'stopPrice');
-            if (stopPrice === undefined) {
-                throw new ArgumentsRequired(this.id + ' createOrder() requires a stopPx or stopPrice parameter for the ' + orderType + ' order type');
+        const customTriggerType = (orderType === 'Stop') || (orderType === 'StopLimit') || (orderType === 'MarketIfTouched') || (orderType === 'LimitIfTouched');
+        // support for unified trigger format
+        const triggerPrice = this.safeNumberN(params, ['triggerPrice', 'stopPx', 'stopPrice']);
+        if ((triggerPrice !== undefined) && !customTriggerType) {
+            request['stopPx'] = parseFloat(this.priceToPrecision(symbol, triggerPrice));
+            const triggerDirection = this.safeString(params, 'triggerDirection');
+            params = this.omit(params, ['triggerPrice', 'stopPrice', 'stopPx', 'triggerDirection']);
+            const triggerAbove = (triggerDirection === 'above');
+            this.checkRequiredArgument('createOrder', triggerDirection, 'triggerDirection', ['above', 'below']);
+            this.checkRequiredArgument('createOrder', side, 'side', ['buy', 'sell']);
+            if (type === 'limit') {
+                request['price'] = parseFloat(this.priceToPrecision(symbol, price));
+                if (side === 'buy') {
+                    request['ordType'] = triggerAbove ? 'StopLimit' : 'LimitIfTouched';
+                }
+                else {
+                    request['ordType'] = triggerAbove ? 'LimitIfTouched' : 'StopLimit';
+                }
             }
-            else {
-                request['stopPx'] = parseFloat(this.priceToPrecision(symbol, stopPrice));
-                params = this.omit(params, ['stopPx', 'stopPrice']);
+            else if (type === 'market') {
+                if (side === 'buy') {
+                    request['ordType'] = triggerAbove ? 'Stop' : 'MarketIfTouched';
+                }
+                else {
+                    request['ordType'] = triggerAbove ? 'MarketIfTouched' : 'Stop';
+                }
+            }
+        }
+        else if (customTriggerType) {
+            if (triggerPrice === undefined) {
+                // if exchange specific trigger types were provided
+                throw new ArgumentsRequired(this.id + ' createOrder() requires a triggerPrice (stopPx|stopPrice) parameter for the ' + orderType + ' order type');
             }
+            params = this.omit(params, ['triggerPrice', 'stopPrice', 'stopPx']);
+            request['stopPx'] = parseFloat(this.priceToPrecision(symbol, triggerPrice));
         }
         if ((orderType === 'Limit') || (orderType === 'StopLimit') || (orderType === 'LimitIfTouched')) {
             request['price'] = parseFloat(this.priceToPrecision(symbol, price));
@@ -1887,7 +1923,7 @@ export default class bitmex extends Exchange {
          * @param {string} id order id
          * @param {string} symbol not used by bitmex cancelOrder ()
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} An [order structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+         * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
          */
         await this.loadMarkets();
         // https://github.com/ccxt/ccxt/issues/6507
@@ -1918,7 +1954,7 @@ export default class bitmex extends Exchange {
          * @param {string[]} ids order ids
          * @param {string} symbol not used by bitmex cancelOrders ()
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} an list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+         * @returns {object} an list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
          */
         // return await this.cancelOrder (ids, symbol, params);
         await this.loadMarkets();
@@ -1942,7 +1978,7 @@ export default class bitmex extends Exchange {
          * @description cancel all open orders
          * @param {string} symbol unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object[]} a list of [order structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#order-structure}
+         * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
          */
         await this.loadMarkets();
         const request = {};
@@ -2000,7 +2036,7 @@ export default class bitmex extends Exchange {
          * @description fetch all open positions
          * @param {string[]|undefined} symbols list of unified market symbols
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object[]} a list of [position structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#position-structure}
+         * @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/#/?id=position-structure}
          */
         await this.loadMarkets();
         const response = await this.privateGetPosition(params);
@@ -2261,7 +2297,7 @@ export default class bitmex extends Exchange {
          * @param {string} address the address to withdraw to
          * @param {string} tag
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} a [transaction structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#transaction-structure}
+         * @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
          */
         [tag, params] = this.handleWithdrawTagAndParams(tag, params);
         this.checkAddress(address);
@@ -2305,7 +2341,7 @@ export default class bitmex extends Exchange {
          * @description fetch the funding rate for multiple markets
          * @param {string[]|undefined} symbols list of unified market symbols
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} a dictionary of [funding rates structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#funding-rates-structure}, indexe by market symbols
+         * @returns {object} a dictionary of [funding rates structures]{@link https://docs.ccxt.com/#/?id=funding-rates-structure}, indexe by market symbols
          */
         await this.loadMarkets();
         const response = await this.publicGetInstrumentActiveAndIndices(params);
@@ -2356,14 +2392,14 @@ export default class bitmex extends Exchange {
          * @description Fetches the history of funding rates
          * @param {string} symbol unified symbol of the market to fetch the funding rate history for
          * @param {int} [since] timestamp in ms of the earliest funding rate to fetch
-         * @param {int} [limit] the maximum amount of [funding rate structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-history-structure} to fetch
+         * @param {int} [limit] the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure} to fetch
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
          * @param {int} [params.until] timestamp in ms for ending date filter
          * @param {bool} [params.reverse] if true, will sort results newest first
          * @param {int} [params.start] starting point for results
          * @param {string} [params.columns] array of column names to fetch in info, if omitted, will return all columns
          * @param {string} [params.filter] generic table filter, send json key/value pairs, such as {"key": "value"}, you can key on individual fields, and do more advanced querying on timestamps, see the [timestamp docs]{@link https://www.bitmex.com/app/restAPI#Timestamp-Filters} for more details
-         * @returns {object[]} a list of [funding rate structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-history-structure}
+         * @returns {object[]} a list of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure}
          */
         await this.loadMarkets();
         const request = {};
@@ -2442,7 +2478,9 @@ export default class bitmex extends Exchange {
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
          * @returns {object} response from the exchange
          */
-        this.checkRequiredSymbol('setLeverage', symbol);
+        if (symbol === undefined) {
+            throw new ArgumentsRequired(this.id + ' setLeverage() requires a symbol argument');
+        }
         if ((leverage < 0.01) || (leverage > 100)) {
             throw new BadRequest(this.id + ' leverage should be between 0.01 and 100');
         }
@@ -2467,7 +2505,9 @@ export default class bitmex extends Exchange {
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
          * @returns {object} response from the exchange
          */
-        this.checkRequiredSymbol('setMarginMode', symbol);
+        if (symbol === undefined) {
+            throw new ArgumentsRequired(this.id + ' setMarginMode() requires a symbol argument');
+        }
         marginMode = marginMode.toLowerCase();
         if (marginMode !== 'isolated' && marginMode !== 'cross') {
             throw new BadRequest(this.id + ' setMarginMode() marginMode argument should be isolated or cross');
@@ -2493,7 +2533,7 @@ export default class bitmex extends Exchange {
          * @param {string} code unified currency code
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
          * @param {string} [params.network] deposit chain, can view all chains via this.publicGetWalletAssets, default is eth, unless the currency has a default chain within this.options['networks']
-         * @returns {object} an [address structure]{@link https://github.com/ccxt/ccxt/wiki/Manual#address-structure}
+         * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
          */
         await this.loadMarkets();
         let networkCode = undefined;
@@ -2593,7 +2633,7 @@ export default class bitmex extends Exchange {
          * @see https://www.bitmex.com/api/explorer/#!/Wallet/Wallet_getAssetsConfig
          * @param {string[]|undefined} codes list of unified currency codes
          * @param {object} [params] extra parameters specific to the bitmex api endpoint
-         * @returns {object} a list of [fee structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#fee-structure}
+         * @returns {object} a list of [fee structures]{@link https://docs.ccxt.com/#/?id=fee-structure}
          */
         await this.loadMarkets();
         const assets = await this.publicGetWalletAssets(params);
@@ -2653,7 +2693,7 @@ export default class bitmex extends Exchange {
          * @param {object} [params] exchange specific parameters for the bitmex api endpoint
          * @param {int} [params.until] timestamp in ms of the latest liquidation
          * @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
-         * @returns {object} an array of [liquidation structures]{@link https://github.com/ccxt/ccxt/wiki/Manual#liquidation-structure}
+         * @returns {object} an array of [liquidation structures]{@link https://docs.ccxt.com/#/?id=liquidation-structure}
          */
         await this.loadMarkets();
         let paginate = false;