ccxt 4.4.30 → 4.4.32

package/dist/cjs/src/yobit.js

@@ -332,15 +332,15 @@ class yobit extends yobit$1 {
         }
         return this.safeBalance(result);
     }
+    /**
+     * @method
+     * @name yobit#fetchBalance
+     * @see https://yobit.net/en/api
+     * @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 exchange API endpoint
+     * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
+     */
     async fetchBalance(params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchBalance
-         * @see https://yobit.net/en/api
-         * @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 exchange API endpoint
-         * @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
-         */
         await this.loadMarkets();
         const response = await this.privatePostGetInfo(params);
         //
@@ -370,15 +370,15 @@ class yobit extends yobit$1 {
         //
         return this.parseBalance(response);
     }
+    /**
+     * @method
+     * @name yobit#fetchMarkets
+     * @see https://yobit.net/en/api
+     * @description retrieves data on all markets for yobit
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} an array of objects representing market data
+     */
     async fetchMarkets(params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchMarkets
-         * @see https://yobit.net/en/api
-         * @description retrieves data on all markets for yobit
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object[]} an array of objects representing market data
-         */
         const response = await this.publicGetInfo(params);
         //
         //     {
@@ -467,17 +467,17 @@ class yobit extends yobit$1 {
         }
         return result;
     }
+    /**
+     * @method
+     * @name yobit#fetchOrderBook
+     * @see https://yobit.net/en/api
+     * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
+     * @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 exchange API endpoint
+     * @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
+     */
     async fetchOrderBook(symbol, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchOrderBook
-         * @see https://yobit.net/en/api
-         * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data
-         * @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 exchange API endpoint
-         * @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);
         const request = {
@@ -494,17 +494,17 @@ class yobit extends yobit$1 {
         const orderbook = response[market['id']];
         return this.parseOrderBook(orderbook, symbol);
     }
+    /**
+     * @method
+     * @name yobit#fetchOrderBooks
+     * @see https://yobit.net/en/api
+     * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for multiple markets
+     * @param {string[]|undefined} symbols list of unified market symbols, all symbols fetched if undefined, default is undefined
+     * @param {int} [limit] max number of entries per orderbook to return, default is undefined
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbol
+     */
     async fetchOrderBooks(symbols = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchOrderBooks
-         * @see https://yobit.net/en/api
-         * @description fetches information on open orders with bid (buy) and ask (sell) prices, volumes and other data for multiple markets
-         * @param {string[]|undefined} symbols list of unified market symbols, all symbols fetched if undefined, default is undefined
-         * @param {int} [limit] max number of entries per orderbook to return, default is undefined
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} a dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbol
-         */
         await this.loadMarkets();
         let ids = undefined;
         if (symbols === undefined) {
@@ -591,17 +591,17 @@ class yobit extends yobit$1 {
         }
         return result;
     }
+    /**
+     * @method
+     * @name yobit#fetchTickers
+     * @see https://yobit.net/en/api
+     * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for 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 exchange API endpoint
+     * @param {object} [params.all] you can set to `true` for convenience to fetch all tickers from this exchange by sending multiple requests
+     * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+     */
     async fetchTickers(symbols = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchTickers
-         * @see https://yobit.net/en/api
-         * @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for 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 exchange API endpoint
-         * @param {object} [params.all] you can set to `true` for convenience to fetch all tickers from this exchange by sending multiple requests
-         * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
-         */
         let allSymbols = undefined;
         [allSymbols, params] = this.handleParamBool(params, 'all', false);
         if (symbols === undefined && !allSymbols) {
@@ -647,16 +647,16 @@ class yobit extends yobit$1 {
         }
         return finalResult;
     }
+    /**
+     * @method
+     * @name yobit#fetchTicker
+     * @see https://yobit.net/en/api
+     * @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 exchange API endpoint
+     * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+     */
     async fetchTicker(symbol, params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchTicker
-         * @see https://yobit.net/en/api
-         * @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 exchange API endpoint
-         * @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
-         */
         const tickers = await this.fetchTickers([symbol], params);
         return tickers[symbol];
     }
@@ -739,18 +739,18 @@ class yobit extends yobit$1 {
             'info': trade,
         }, market);
     }
+    /**
+     * @method
+     * @name yobit#fetchTrades
+     * @see https://yobit.net/en/api
+     * @description get the list of most recent trades for a particular symbol
+     * @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 exchange API endpoint
+     * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
+     */
     async fetchTrades(symbol, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchTrades
-         * @see https://yobit.net/en/api
-         * @description get the list of most recent trades for a particular symbol
-         * @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 exchange API endpoint
-         * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const request = {
@@ -782,15 +782,15 @@ class yobit extends yobit$1 {
         const result = this.safeList(response, market['id'], []);
         return this.parseTrades(result, market, since, limit);
     }
+    /**
+     * @method
+     * @name yobit#fetchTradingFees
+     * @see https://yobit.net/en/api
+     * @description fetch the trading fees for multiple markets
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a dictionary of [fee structures]{@link https://docs.ccxt.com/#/?id=fee-structure} indexed by market symbols
+     */
     async fetchTradingFees(params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchTradingFees
-         * @see https://yobit.net/en/api
-         * @description fetch the trading fees for multiple markets
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} a dictionary of [fee structures]{@link https://docs.ccxt.com/#/?id=fee-structure} indexed by market symbols
-         */
         await this.loadMarkets();
         const response = await this.publicGetInfo(params);
         //
@@ -834,20 +834,20 @@ class yobit extends yobit$1 {
         }
         return result;
     }
+    /**
+     * @method
+     * @name yobit#createOrder
+     * @see https://yobit.net/en/api
+     * @description create a trade order
+     * @param {string} symbol unified symbol of the market to create an order in
+     * @param {string} type must be '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 fulfilled, in units of the quote currency, ignored in market orders
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
+     */
     async createOrder(symbol, type, side, amount, price = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#createOrder
-         * @see https://yobit.net/en/api
-         * @description create a trade order
-         * @param {string} symbol unified symbol of the market to create an order in
-         * @param {string} type must be '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 fulfilled, in units of the quote currency, ignored in market orders
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
-         */
         if (type === 'market') {
             throw new errors.ExchangeError(this.id + ' createOrder() allows limit orders only');
         }
@@ -884,17 +884,17 @@ class yobit extends yobit$1 {
         const result = this.safeDict(response, 'return');
         return this.parseOrder(result, market);
     }
+    /**
+     * @method
+     * @name yobit#cancelOrder
+     * @see https://yobit.net/en/api
+     * @description cancels an open order
+     * @param {string} id order id
+     * @param {string} symbol not used by yobit cancelOrder ()
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
+     */
     async cancelOrder(id, symbol = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#cancelOrder
-         * @see https://yobit.net/en/api
-         * @description cancels an open order
-         * @param {string} id order id
-         * @param {string} symbol not used by yobit cancelOrder ()
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
-         */
         await this.loadMarkets();
         const request = {
             'order_id': parseInt(id),
@@ -1034,16 +1034,17 @@ class yobit extends yobit$1 {
             'trades': undefined,
         }, market);
     }
+    /**
+     * @method
+     * @name yobit#fetchOrder
+     * @see https://yobit.net/en/api
+     * @description fetches information on an order made by the user
+     * @param {string} id order id
+     * @param {string} symbol not used by yobit fetchOrder
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
+     */
     async fetchOrder(id, symbol = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchOrder
-         * @see https://yobit.net/en/api
-         * @description fetches information on an order made by the user
-         * @param {string} symbol not used by yobit fetchOrder
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
-         */
         await this.loadMarkets();
         const request = {
             'order_id': parseInt(id),
@@ -1069,18 +1070,18 @@ class yobit extends yobit$1 {
         //
         return this.parseOrder(this.extend({ 'id': id }, orders[id]));
     }
+    /**
+     * @method
+     * @name yobit#fetchOpenOrders
+     * @see https://yobit.net/en/api
+     * @description fetch all unfilled currently open orders
+     * @param {string} symbol unified market symbol
+     * @param {int} [since] the earliest time in ms to fetch open orders for
+     * @param {int} [limit] the maximum number of open order structures to retrieve
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
+     */
     async fetchOpenOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchOpenOrders
-         * @see https://yobit.net/en/api
-         * @description fetch all unfilled currently open orders
-         * @param {string} symbol unified market symbol
-         * @param {int} [since] the earliest time in ms to fetch open orders for
-         * @param {int} [limit] the maximum number of open order structures to retrieve
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
-         */
         if (symbol === undefined) {
             throw new errors.ArgumentsRequired(this.id + ' fetchOpenOrders() requires a symbol argument');
         }
@@ -1118,18 +1119,18 @@ class yobit extends yobit$1 {
         const result = this.safeDict(response, 'return', {});
         return this.parseOrders(result, market, since, limit);
     }
+    /**
+     * @method
+     * @name yobit#fetchMyTrades
+     * @see https://yobit.net/en/api
+     * @description fetch all trades made by the user
+     * @param {string} symbol unified market symbol
+     * @param {int} [since] the earliest time in ms to fetch trades for
+     * @param {int} [limit] the maximum number of trades structures to retrieve
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
+     */
     async fetchMyTrades(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchMyTrades
-         * @see https://yobit.net/en/api
-         * @description fetch all trades made by the user
-         * @param {string} symbol unified market symbol
-         * @param {int} [since] the earliest time in ms to fetch trades for
-         * @param {int} [limit] the maximum number of trades structures to retrieve
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
-         */
         if (symbol === undefined) {
             throw new errors.ArgumentsRequired(this.id + ' fetchMyTrades() requires a symbol argument');
         }
@@ -1181,16 +1182,16 @@ class yobit extends yobit$1 {
         }
         return this.filterBySymbolSinceLimit(result, market['symbol'], since, limit);
     }
+    /**
+     * @method
+     * @name yobit#createDepositAddress
+     * @see https://yobit.net/en/api
+     * @description create a currency deposit address
+     * @param {string} code unified currency code of the currency for the deposit address
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
+     */
     async createDepositAddress(code, params = {}) {
-        /**
-         * @method
-         * @name yobit#createDepositAddress
-         * @see https://yobit.net/en/api
-         * @description create a currency deposit address
-         * @param {string} code unified currency code of the currency for the deposit address
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
-         */
         const request = {
             'need_new': 1,
         };
@@ -1204,16 +1205,16 @@ class yobit extends yobit$1 {
             'info': response['info'],
         };
     }
+    /**
+     * @method
+     * @name yobit#fetchDepositAddress
+     * @description fetch the deposit address for a currency associated with this account
+     * @see https://yobit.net/en/api
+     * @param {string} code unified currency code
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
+     */
     async fetchDepositAddress(code, params = {}) {
-        /**
-         * @method
-         * @name yobit#fetchDepositAddress
-         * @description fetch the deposit address for a currency associated with this account
-         * @see https://yobit.net/en/api
-         * @param {string} code unified currency code
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
-         */
         await this.loadMarkets();
         const currency = this.currency(code);
         let currencyId = currency['id'];
@@ -1241,19 +1242,19 @@ class yobit extends yobit$1 {
             'tag': undefined,
         };
     }
+    /**
+     * @method
+     * @name yobit#withdraw
+     * @see https://yobit.net/en/api
+     * @description make a withdrawal
+     * @param {string} code unified currency code
+     * @param {float} amount the amount to withdraw
+     * @param {string} address the address to withdraw to
+     * @param {string} tag
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
+     */
     async withdraw(code, amount, address, tag = undefined, params = {}) {
-        /**
-         * @method
-         * @name yobit#withdraw
-         * @see https://yobit.net/en/api
-         * @description make a withdrawal
-         * @param {string} code unified currency code
-         * @param {float} amount the amount to withdraw
-         * @param {string} address the address to withdraw to
-         * @param {string} tag
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-         */
         [tag, params] = this.handleWithdrawTagAndParams(tag, params);
         this.checkAddress(address);
         await this.loadMarkets();