ccxt 4.4.30 → 4.4.32

package/dist/cjs/src/btcalpha.js

@@ -155,15 +155,15 @@ class btcalpha extends btcalpha$1 {
             },
         });
     }
+    /**
+     * @method
+     * @name btcalpha#fetchMarkets
+     * @description retrieves data on all markets for btcalpha
+     * @see https://btc-alpha.github.io/api-docs/#list-all-currencies
+     * @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 btcalpha#fetchMarkets
-         * @description retrieves data on all markets for btcalpha
-         * @see https://btc-alpha.github.io/api-docs/#list-all-currencies
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object[]} an array of objects representing market data
-         */
         const response = await this.publicGetPairs(params);
         //
         //    [
@@ -241,16 +241,16 @@ class btcalpha extends btcalpha$1 {
             'info': market,
         };
     }
+    /**
+     * @method
+     * @name btcalpha#fetchTickers
+     * @see https://btc-alpha.github.io/api-docs/#tickers
+     * @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
+     * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
+     */
     async fetchTickers(symbols = undefined, params = {}) {
-        /**
-         * @method
-         * @name btcalpha#fetchTickers
-         * @see https://btc-alpha.github.io/api-docs/#tickers
-         * @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
-         * @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
-         */
         await this.loadMarkets();
         const response = await this.publicGetTicker(params);
         //
@@ -271,16 +271,16 @@ class btcalpha extends btcalpha$1 {
         //
         return this.parseTickers(response, symbols);
     }
+    /**
+     * @method
+     * @name btcalpha#fetchTicker
+     * @see https://btc-alpha.github.io/api-docs/#tickers
+     * @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 btcalpha#fetchTicker
-         * @see https://btc-alpha.github.io/api-docs/#tickers
-         * @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}
-         */
         await this.loadMarkets();
         const market = this.market(symbol);
         const request = {
@@ -344,17 +344,17 @@ class btcalpha extends btcalpha$1 {
             'quoteVolume': this.safeString(ticker, 'vol'),
         }, market);
     }
+    /**
+     * @method
+     * @name btcalpha#fetchOrderBook
+     * @see https://btc-alpha.github.io/api-docs/#get-orderbook
+     * @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 btcalpha#fetchOrderBook
-         * @see https://btc-alpha.github.io/api-docs/#get-orderbook
-         * @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 = {
@@ -426,18 +426,18 @@ class btcalpha extends btcalpha$1 {
             'fee': undefined,
         }, market);
     }
+    /**
+     * @method
+     * @name btcalpha#fetchTrades
+     * @description get the list of most recent trades for a particular symbol
+     * @see https://btc-alpha.github.io/api-docs/#list-all-exchanges
+     * @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 btcalpha#fetchTrades
-         * @description get the list of most recent trades for a particular symbol
-         * @see https://btc-alpha.github.io/api-docs/#list-all-exchanges
-         * @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();
         let market = undefined;
         const request = {};
@@ -451,18 +451,18 @@ class btcalpha extends btcalpha$1 {
         const trades = await this.publicGetExchanges(this.extend(request, params));
         return this.parseTrades(trades, market, since, limit);
     }
+    /**
+     * @method
+     * @name btcalpha#fetchDeposits
+     * @description fetch all deposits made to an account
+     * @see https://btc-alpha.github.io/api-docs/#list-own-deposits
+     * @param {string} code unified currency code
+     * @param {int} [since] the earliest time in ms to fetch deposits for
+     * @param {int} [limit] the maximum number of deposits structures to retrieve
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
+     */
     async fetchDeposits(code = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name btcalpha#fetchDeposits
-         * @description fetch all deposits made to an account
-         * @see https://btc-alpha.github.io/api-docs/#list-own-deposits
-         * @param {string} code unified currency code
-         * @param {int} [since] the earliest time in ms to fetch deposits for
-         * @param {int} [limit] the maximum number of deposits structures to retrieve
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-         */
         await this.loadMarkets();
         let currency = undefined;
         if (code !== undefined) {
@@ -481,18 +481,18 @@ class btcalpha extends btcalpha$1 {
         //
         return this.parseTransactions(response, currency, since, limit, { 'type': 'deposit' });
     }
+    /**
+     * @method
+     * @name btcalpha#fetchWithdrawals
+     * @description fetch all withdrawals made from an account
+     * @see https://btc-alpha.github.io/api-docs/#list-own-made-withdraws
+     * @param {string} code unified currency code
+     * @param {int} [since] the earliest time in ms to fetch withdrawals for
+     * @param {int} [limit] the maximum number of withdrawals structures to retrieve
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
+     */
     async fetchWithdrawals(code = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name btcalpha#fetchWithdrawals
-         * @description fetch all withdrawals made from an account
-         * @see https://btc-alpha.github.io/api-docs/#list-own-made-withdraws
-         * @param {string} code unified currency code
-         * @param {int} [since] the earliest time in ms to fetch withdrawals for
-         * @param {int} [limit] the maximum number of withdrawals structures to retrieve
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
-         */
         await this.loadMarkets();
         let currency = undefined;
         const request = {};
@@ -589,19 +589,19 @@ class btcalpha extends btcalpha$1 {
             this.safeNumber(ohlcv, 'volume'),
         ];
     }
+    /**
+     * @method
+     * @name btcalpha#fetchOHLCV
+     * @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
+     * @see https://btc-alpha.github.io/api-docs/#charts
+     * @param {string} symbol unified symbol of the market to fetch OHLCV data for
+     * @param {string} timeframe the length of time each candle represents
+     * @param {int} [since] timestamp in ms of the earliest candle to fetch
+     * @param {int} [limit] the maximum amount of candles to fetch
+     * @param {object} [params] extra parameters specific to the exchange API endpoint
+     * @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
+     */
     async fetchOHLCV(symbol, timeframe = '5m', since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name btcalpha#fetchOHLCV
-         * @description fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-         * @see https://btc-alpha.github.io/api-docs/#charts
-         * @param {string} symbol unified symbol of the market to fetch OHLCV data for
-         * @param {string} timeframe the length of time each candle represents
-         * @param {int} [since] timestamp in ms of the earliest candle to fetch
-         * @param {int} [limit] the maximum amount of candles to fetch
-         * @param {object} [params] extra parameters specific to the exchange 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 request = {
@@ -637,15 +637,15 @@ class btcalpha extends btcalpha$1 {
         }
         return this.safeBalance(result);
     }
+    /**
+     * @method
+     * @name btcalpha#fetchBalance
+     * @description query for balance and get the amount of funds available for trading or funds locked in orders
+     * @see https://btc-alpha.github.io/api-docs/#list-own-wallets
+     * @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 btcalpha#fetchBalance
-         * @description query for balance and get the amount of funds available for trading or funds locked in orders
-         * @see https://btc-alpha.github.io/api-docs/#list-own-wallets
-         * @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.privateGetWallets(params);
         return this.parseBalance(response);
@@ -731,20 +731,20 @@ class btcalpha extends btcalpha$1 {
             'average': undefined,
         }, market);
     }
+    /**
+     * @method
+     * @name btcalpha#createOrder
+     * @see https://btc-alpha.github.io/api-docs/#create-order
+     * @description create a trade order
+     * @param {string} symbol unified symbol of the market to create an order in
+     * @param {string} type '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 btcalpha#createOrder
-         * @see https://btc-alpha.github.io/api-docs/#create-order
-         * @description create a trade order
-         * @param {string} symbol unified symbol of the market to create an order in
-         * @param {string} type '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.InvalidOrder(this.id + ' only limits orders are supported');
         }
@@ -766,17 +766,17 @@ class btcalpha extends btcalpha$1 {
         order['amount'] = this.parseNumber(amount);
         return order;
     }
+    /**
+     * @method
+     * @name btcalpha#cancelOrder
+     * @see https://btc-alpha.github.io/api-docs/#cancel-order
+     * @description cancels an open order
+     * @param {string} id order id
+     * @param {string} symbol unified symbol of the market the order was made in
+     * @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 btcalpha#cancelOrder
-         * @see https://btc-alpha.github.io/api-docs/#cancel-order
-         * @description cancels an open order
-         * @param {string} id order id
-         * @param {string} symbol unified symbol of the market the order was made in
-         * @param {object} [params] extra parameters specific to the exchange API endpoint
-         * @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
-         */
         const request = {
             'order': id,
         };
@@ -788,17 +788,17 @@ class btcalpha extends btcalpha$1 {
         //
         return this.parseOrder(response);
     }
+    /**
+     * @method
+     * @name btcalpha#fetchOrder
+     * @see https://btc-alpha.github.io/api-docs/#retrieve-single-order
+     * @description fetches information on an order made by the user
+     * @param {string} id the order id
+     * @param {string} symbol not used by btcalpha 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 btcalpha#fetchOrder
-         * @see https://btc-alpha.github.io/api-docs/#retrieve-single-order
-         * @description fetches information on an order made by the user
-         * @param {string} id the order id
-         * @param {string} symbol not used by btcalpha 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 = {
             'id': id,
@@ -806,18 +806,18 @@ class btcalpha extends btcalpha$1 {
         const order = await this.privateGetOrderId(this.extend(request, params));
         return this.parseOrder(order);
     }
+    /**
+     * @method
+     * @name btcalpha#fetchOrders
+     * @see https://btc-alpha.github.io/api-docs/#list-own-orders
+     * @description fetches information on multiple orders made by the user
+     * @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 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 fetchOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name btcalpha#fetchOrders
-         * @see https://btc-alpha.github.io/api-docs/#list-own-orders
-         * @description fetches information on multiple orders made by the user
-         * @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 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}
-         */
         await this.loadMarkets();
         const request = {};
         let market = undefined;
@@ -831,52 +831,52 @@ class btcalpha extends btcalpha$1 {
         const orders = await this.privateGetOrdersOwn(this.extend(request, params));
         return this.parseOrders(orders, market, since, limit);
     }
+    /**
+     * @method
+     * @name btcalpha#fetchOpenOrders
+     * @description fetch all unfilled currently open orders
+     * @see https://btc-alpha.github.io/api-docs/#list-own-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 orders 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 btcalpha#fetchOpenOrders
-         * @description fetch all unfilled currently open orders
-         * @see https://btc-alpha.github.io/api-docs/#list-own-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 orders 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}
-         */
         const request = {
             'status': '1',
         };
         return await this.fetchOrders(symbol, since, limit, this.extend(request, params));
     }
+    /**
+     * @method
+     * @name btcalpha#fetchClosedOrders
+     * @description fetches information on multiple closed orders made by the user
+     * @see https://btc-alpha.github.io/api-docs/#list-own-orders
+     * @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 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 fetchClosedOrders(symbol = undefined, since = undefined, limit = undefined, params = {}) {
-        /**
-         * @method
-         * @name btcalpha#fetchClosedOrders
-         * @description fetches information on multiple closed orders made by the user
-         * @see https://btc-alpha.github.io/api-docs/#list-own-orders
-         * @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 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}
-         */
         const request = {
             'status': '3',
         };
         return await this.fetchOrders(symbol, since, limit, this.extend(request, params));
     }
+    /**
+     * @method
+     * @name btcalpha#fetchMyTrades
+     * @description fetch all trades made by the user
+     * @see https://btc-alpha.github.io/api-docs/#list-own-exchanges
+     * @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 btcalpha#fetchMyTrades
-         * @description fetch all trades made by the user
-         * @see https://btc-alpha.github.io/api-docs/#list-own-exchanges
-         * @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}
-         */
         await this.loadMarkets();
         const request = {};
         if (symbol !== undefined) {