ccxt 4.4.30 → 4.4.32

package/dist/cjs/src/pro/xt.js

@@ -47,16 +47,16 @@ class xt extends xt$1 {
             'token': undefined,
         });
     }
+    /**
+     * @ignore
+     * @method
+     * @description required for private endpoints
+     * @param {string} isContract true for contract trades
+     * @see https://doc.xt.com/#websocket_privategetToken
+     * @see https://doc.xt.com/#futures_user_websocket_v2base
+     * @returns {string} listen key / access token
+     */
     async getListenKey(isContract) {
-        /**
-         * @ignore
-         * @method
-         * @description required for private endpoints
-         * @param {string} isContract true for contract trades
-         * @see https://doc.xt.com/#websocket_privategetToken
-         * @see https://doc.xt.com/#futures_user_websocket_v2base
-         * @returns {string} listen key / access token
-         */
         this.checkRequiredCredentials();
         const tradeType = isContract ? 'contract' : 'spot';
         let url = this.urls['api']['ws'][tradeType];
@@ -135,21 +135,21 @@ class xt extends xt$1 {
         // this.handleBidAsks (storedBids, bids);
         // this.handleBidAsks (storedAsks, asks);
     }
+    /**
+     * @ignore
+     * @method
+     * @description Connects to a websocket channel
+     * @see https://doc.xt.com/#websocket_privaterequestFormat
+     * @see https://doc.xt.com/#futures_market_websocket_v2base
+     * @param {string} name name of the channel
+     * @param {string} access public or private
+     * @param {string} methodName the name of the CCXT class method
+     * @param {object} [market] CCXT market
+     * @param {string[]} [symbols] unified market symbols
+     * @param {object} params extra parameters specific to the xt api
+     * @returns {object} data from the websocket stream
+     */
     async subscribe(name, access, methodName, market = undefined, symbols = undefined, params = {}) {
-        /**
-         * @ignore
-         * @method
-         * @description Connects to a websocket channel
-         * @see https://doc.xt.com/#websocket_privaterequestFormat
-         * @see https://doc.xt.com/#futures_market_websocket_v2base
-         * @param {string} name name of the channel
-         * @param {string} access public or private
-         * @param {string} methodName the name of the CCXT class method
-         * @param {object} [market] CCXT market
-         * @param {string[]} [symbols] unified market symbols
-         * @param {object} params extra parameters specific to the xt api
-         * @returns {object} data from the websocket stream
-         */
         const privateAccess = access === 'private';
         let type = undefined;
         [type, params] = this.handleMarketTypeAndParams(methodName, market, params);
@@ -185,19 +185,19 @@ class xt extends xt$1 {
         const url = this.urls['api']['ws'][tradeType] + '/' + tail;
         return await this.watch(url, messageHash, request, messageHash);
     }
+    /**
+     * @method
+     * @name xt#watchTicker
+     * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @see https://doc.xt.com/#websocket_publictickerRealTime
+     * @see https://doc.xt.com/#futures_market_websocket_v2tickerRealTime
+     * @see https://doc.xt.com/#futures_market_websocket_v2aggTickerRealTime
+     * @param {string} symbol unified symbol of the market to fetch the ticker for
+     * @param {object} params extra parameters specific to the xt api endpoint
+     * @param {string} [params.method] 'agg_ticker' (contract only) or 'ticker', default = 'ticker' - the endpoint that will be streamed
+     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/en/latest/manual.html#ticker-structure}
+     */
     async watchTicker(symbol, params = {}) {
-        /**
-         * @method
-         * @name xt#watchTicker
-         * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-         * @see https://doc.xt.com/#websocket_publictickerRealTime
-         * @see https://doc.xt.com/#futures_market_websocket_v2tickerRealTime
-         * @see https://doc.xt.com/#futures_market_websocket_v2aggTickerRealTime
-         * @param {string} symbol unified symbol of the market to fetch the ticker for
-         * @param {object} params extra parameters specific to the xt api endpoint
-         * @param {string} [params.method] 'agg_ticker' (contract only) or 'ticker', default = 'ticker' - the endpoint that will be streamed
-         * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/en/latest/manual.html#ticker-structure}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const options = this.safeDict(this.options, 'watchTicker');
@@ -206,19 +206,19 @@ class xt extends xt$1 {
         const name = method + '@' + market['id'];
         return await this.subscribe(name, 'public', 'watchTicker', market, undefined, params);
     }
+    /**
+     * @method
+     * @name xt#watchTicker
+     * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
+     * @see https://doc.xt.com/#websocket_publicallTicker
+     * @see https://doc.xt.com/#futures_market_websocket_v2allTicker
+     * @see https://doc.xt.com/#futures_market_websocket_v2allAggTicker
+     * @param {string} [symbols] unified market symbols
+     * @param {object} params extra parameters specific to the xt api endpoint
+     * @param {string} [params.method] 'agg_tickers' (contract only) or 'tickers', default = 'tickers' - the endpoint that will be streamed
+     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/en/latest/manual.html#ticker-structure}
+     */
     async watchTickers(symbols = undefined, params = {}) {
-        /**
-         * @method
-         * @name xt#watchTicker
-         * @description watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-         * @see https://doc.xt.com/#websocket_publicallTicker
-         * @see https://doc.xt.com/#futures_market_websocket_v2allTicker
-         * @see https://doc.xt.com/#futures_market_websocket_v2allAggTicker
-         * @param {string} [symbols] unified market symbols
-         * @param {object} params extra parameters specific to the xt api endpoint
-         * @param {string} [params.method] 'agg_tickers' (contract only) or 'tickers', default = 'tickers' - the endpoint that will be streamed
-         * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/en/latest/manual.html#ticker-structure}
-         */
         await this.loadMarkets();
         const options = this.safeDict(this.options, 'watchTickers');
         const defaultMethod = this.safeString(options, 'method', 'tickers');
@@ -233,20 +233,20 @@ class xt extends xt$1 {
         }
         return this.filterByArray(this.tickers, 'symbol', symbols);
     }
+    /**
+     * @method
+     * @name hitbtc#watchOHLCV
+     * @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+     * @see https://doc.xt.com/#websocket_publicsymbolKline
+     * @see https://doc.xt.com/#futures_market_websocket_v2symbolKline
+     * @param {string} symbol unified symbol of the market to fetch OHLCV data for
+     * @param {string} timeframe 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, or 1M
+     * @param {int} [since] not used by xt watchOHLCV
+     * @param {int} [limit] not used by xt watchOHLCV
+     * @param {object} params extra parameters specific to the xt api endpoint
+     * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
+     */
     async watchOHLCV(symbol, timeframe = '1m', since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name hitbtc#watchOHLCV
-         * @description watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-         * @see https://doc.xt.com/#websocket_publicsymbolKline
-         * @see https://doc.xt.com/#futures_market_websocket_v2symbolKline
-         * @param {string} symbol unified symbol of the market to fetch OHLCV data for
-         * @param {string} timeframe 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, or 1M
-         * @param {int} [since] not used by xt watchOHLCV
-         * @param {int} [limit] not used by xt watchOHLCV
-         * @param {object} params extra parameters specific to the xt api endpoint
-         * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const name = 'kline@' + market['id'] + ',' + timeframe;
@@ -256,19 +256,19 @@ class xt extends xt$1 {
         }
         return this.filterBySinceLimit(ohlcv, since, limit, 0, true);
     }
+    /**
+     * @method
+     * @name xt#watchTrades
+     * @description get the list of most recent trades for a particular symbol
+     * @see https://doc.xt.com/#websocket_publicdealRecord
+     * @see https://doc.xt.com/#futures_market_websocket_v2dealRecord
+     * @param {string} symbol unified symbol of the market to fetch trades for
+     * @param {int} [since] timestamp in ms of the earliest trade to fetch
+     * @param {int} [limit] the maximum amount of trades to fetch
+     * @param {object} params extra parameters specific to the xt api endpoint
+     * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades}
+     */
     async watchTrades(symbol, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name xt#watchTrades
-         * @description get the list of most recent trades for a particular symbol
-         * @see https://doc.xt.com/#websocket_publicdealRecord
-         * @see https://doc.xt.com/#futures_market_websocket_v2dealRecord
-         * @param {string} symbol unified symbol of the market to fetch trades for
-         * @param {int} [since] timestamp in ms of the earliest trade to fetch
-         * @param {int} [limit] the maximum amount of trades to fetch
-         * @param {object} params extra parameters specific to the xt api endpoint
-         * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const name = 'trade@' + market['id'];
@@ -278,21 +278,21 @@ class xt extends xt$1 {
         }
         return this.filterBySinceLimit(trades, since, limit, 'timestamp');
     }
+    /**
+     * @method
+     * @name xt#watchOrderBook
+     * @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+     * @see https://doc.xt.com/#websocket_publiclimitDepth
+     * @see https://doc.xt.com/#websocket_publicincreDepth
+     * @see https://doc.xt.com/#futures_market_websocket_v2limitDepth
+     * @see https://doc.xt.com/#futures_market_websocket_v2increDepth
+     * @param {string} symbol unified symbol of the market to fetch the order book for
+     * @param {int} [limit] not used by xt watchOrderBook
+     * @param {object} params extra parameters specific to the xt api endpoint
+     * @param {int} [params.levels] 5, 10, 20, or 50
+     * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-book-structure} indexed by market symbols
+     */
     async watchOrderBook(symbol, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name xt#watchOrderBook
-         * @description watches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
-         * @see https://doc.xt.com/#websocket_publiclimitDepth
-         * @see https://doc.xt.com/#websocket_publicincreDepth
-         * @see https://doc.xt.com/#futures_market_websocket_v2limitDepth
-         * @see https://doc.xt.com/#futures_market_websocket_v2increDepth
-         * @param {string} symbol unified symbol of the market to fetch the order book for
-         * @param {int} [limit] not used by xt watchOrderBook
-         * @param {object} params extra parameters specific to the xt api endpoint
-         * @param {int} [params.levels] 5, 10, 20, or 50
-         * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-book-structure} indexed by market symbols
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const levels = this.safeString(params, 'levels');
@@ -304,19 +304,19 @@ class xt extends xt$1 {
         const orderbook = await this.subscribe(name, 'public', 'watchOrderBook', market, undefined, params);
         return orderbook.limit();
     }
+    /**
+     * @method
+     * @name xt#watchOrders
+     * @description watches information on multiple orders made by the user
+     * @see https://doc.xt.com/#websocket_privateorderChange
+     * @see https://doc.xt.com/#futures_user_websocket_v2order
+     * @param {string} [symbol] unified market symbol
+     * @param {int} [since] not used by xt watchOrders
+     * @param {int} [limit] the maximum number of orders to return
+     * @param {object} params extra parameters specific to the xt api endpoint
+     * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure}
+     */
     async watchOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name xt#watchOrders
-         * @description watches information on multiple orders made by the user
-         * @see https://doc.xt.com/#websocket_privateorderChange
-         * @see https://doc.xt.com/#futures_user_websocket_v2order
-         * @param {string} [symbol] unified market symbol
-         * @param {int} [since] not used by xt watchOrders
-         * @param {int} [limit] the maximum number of orders to return
-         * @param {object} params extra parameters specific to the xt api endpoint
-         * @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure}
-         */
         await this.loadMarkets();
         const name = 'order';
         let market = undefined;
@@ -329,19 +329,19 @@ class xt extends xt$1 {
         }
         return this.filterBySinceLimit(orders, since, limit, 'timestamp');
     }
+    /**
+     * @method
+     * @name xt#watchMyTrades
+     * @description watches information on multiple trades made by the user
+     * @see https://doc.xt.com/#websocket_privateorderDeal
+     * @see https://doc.xt.com/#futures_user_websocket_v2trade
+     * @param {string} symbol unified market symbol of the market orders were made in
+     * @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 kucoin api endpoint
+     * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
+     */
     async watchMyTrades(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name xt#watchMyTrades
-         * @description watches information on multiple trades made by the user
-         * @see https://doc.xt.com/#websocket_privateorderDeal
-         * @see https://doc.xt.com/#futures_user_websocket_v2trade
-         * @param {string} symbol unified market symbol of the market orders were made in
-         * @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 kucoin api endpoint
-         * @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
-         */
         await this.loadMarkets();
         const name = 'trade';
         let market = undefined;
@@ -354,16 +354,16 @@ class xt extends xt$1 {
         }
         return this.filterBySinceLimit(trades, since, limit, 'timestamp');
     }
+    /**
+     * @method
+     * @name xt#watchOrders
+     * @description watches information on multiple orders made by the user
+     * @see https://doc.xt.com/#websocket_privatebalanceChange
+     * @see https://doc.xt.com/#futures_user_websocket_v2balance
+     * @param {object} params extra parameters specific to the xt api endpoint
+     * @returns {object[]} a list of [balance structures]{@link https://docs.ccxt.com/#/?id=balance-structure}
+     */
     async watchBalance(params = {}) {
-        /**
-         * @method
-         * @name xt#watchOrders
-         * @description watches information on multiple orders made by the user
-         * @see https://doc.xt.com/#websocket_privatebalanceChange
-         * @see https://doc.xt.com/#futures_user_websocket_v2balance
-         * @param {object} params extra parameters specific to the xt api endpoint
-         * @returns {object[]} a list of [balance structures]{@link https://docs.ccxt.com/#/?id=balance-structure}
-         */
         await this.loadMarkets();
         const name = 'balance';
         return await this.subscribe(name, 'private', 'watchBalance', undefined, undefined, params);