From 63ebaf44520836a637447864a68c77847be6489a Mon Sep 17 00:00:00 2001 From: carlosmiei <43336371+carlosmiei@users.noreply.github.com> Date: Mon, 18 Jul 2022 10:18:12 +0100 Subject: [PATCH] float -> number --- js/aax.js | 4 ++-- js/ascendex.js | 2 +- js/bibox.js | 2 +- js/bigone.js | 2 +- js/binance.js | 4 ++-- js/bitfinex.js | 2 +- js/bitfinex2.js | 2 +- js/bitflyer.js | 2 +- js/bitforex.js | 2 +- js/bitget.js | 2 +- js/bitmex.js | 2 +- js/bitopro.js | 22 +++++++++--------- js/bitpanda.js | 24 ++++++++++---------- js/bitrue.js | 20 ++++++++--------- js/bittrex.js | 28 +++++++++++------------ js/bitvavo.js | 30 ++++++++++++------------- js/bkex.js | 16 +++++++------- js/blockchaincom.js | 18 +++++++-------- js/btcalpha.js | 20 ++++++++--------- js/btcbox.js | 10 ++++----- js/btcmarkets.js | 22 +++++++++--------- js/btcturk.js | 14 ++++++------ js/buda.js | 20 ++++++++--------- js/bw.js | 18 +++++++-------- js/bybit.js | 30 ++++++++++++------------- js/bytetrade.js | 20 ++++++++--------- js/cdax.js | 26 +++++++++++----------- js/cex.js | 14 ++++++------ js/coinbasepro.js | 28 +++++++++++------------ js/coinex.js | 48 ++++++++++++++++++++-------------------- js/coinmate.js | 16 +++++++------- js/crex24.js | 26 +++++++++++----------- js/cryptocom.js | 30 ++++++++++++------------- js/delta.js | 18 +++++++-------- js/deribit.js | 30 ++++++++++++------------- js/digifinex.js | 22 +++++++++--------- js/eqonex.js | 20 ++++++++--------- js/ftx.js | 36 +++++++++++++++--------------- js/gate.js | 38 +++++++++++++++---------------- js/hitbtc.js | 20 ++++++++--------- js/hitbtc3.js | 36 +++++++++++++++--------------- js/hollaex.js | 24 ++++++++++---------- js/huobi.js | 40 ++++++++++++++++----------------- js/huobijp.js | 26 +++++++++++----------- js/idex.js | 22 +++++++++--------- js/independentreserve.js | 14 ++++++------ js/indodax.js | 14 ++++++------ js/itbit.js | 14 ++++++------ js/kraken.js | 26 +++++++++++----------- js/kucoin.js | 30 ++++++++++++------------- js/kucoinfutures.js | 26 +++++++++++----------- js/latoken.js | 20 ++++++++--------- js/lbank.js | 14 ++++++------ js/lbank2.js | 22 +++++++++--------- js/liquid.js | 20 ++++++++--------- js/luno.js | 16 +++++++------- js/lykke.js | 18 +++++++-------- js/mercado.js | 16 +++++++------- js/mexc.js | 38 +++++++++++++++---------------- js/mexc3.js | 40 ++++++++++++++++----------------- js/ndax.js | 24 ++++++++++---------- js/novadax.js | 26 +++++++++++----------- js/oceanex.js | 16 +++++++------- js/okcoin.js | 26 +++++++++++----------- js/okx.js | 42 +++++++++++++++++------------------ js/phemex.js | 32 +++++++++++++-------------- js/probit.js | 16 +++++++------- js/qtrade.js | 24 ++++++++++---------- js/ripio.js | 16 +++++++------- js/therock.js | 22 +++++++++--------- js/timex.js | 14 ++++++------ js/upbit.js | 18 +++++++-------- js/vcc.js | 20 ++++++++--------- js/wavesexchange.js | 18 +++++++-------- js/wazirx.js | 14 ++++++------ js/whitebit.js | 24 ++++++++++---------- js/woo.js | 24 ++++++++++---------- js/xena.js | 22 +++++++++--------- js/zaif.js | 14 ++++++------ js/zb.js | 38 +++++++++++++++---------------- 80 files changed, 818 insertions(+), 818 deletions(-) diff --git a/js/aax.js b/js/aax.js index b015a3839414..313f1c973b87 100644 --- a/js/aax.js +++ b/js/aax.js @@ -715,7 +715,7 @@ module.exports = class aax extends Exchange { * @description Either adds or reduces margin in an isolated position in order to set the margin to a specific value * @see https://www.aax.com/apidoc/index.html#modify-isolated-position-margin * @param {string} symbol unified market symbol of the market to set margin in - * @param {float} amount the amount to set the margin to + * @param {number} amount the amount to set the margin to * @param {object} params parameters specific to the aax api endpoint * @returns {object} A [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#add-margin-structure} */ @@ -1838,7 +1838,7 @@ module.exports = class aax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the aax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'orderStatus': '2', // 1 new, 2 filled, 3 canceled diff --git a/js/ascendex.js b/js/ascendex.js index bf650a93c3a6..ce0a92311489 100644 --- a/js/ascendex.js +++ b/js/ascendex.js @@ -1776,7 +1776,7 @@ module.exports = class ascendex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the ascendex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); await this.loadAccounts (); diff --git a/js/bibox.js b/js/bibox.js index ed1f1088ab95..05dfc2df3d79 100644 --- a/js/bibox.js +++ b/js/bibox.js @@ -1409,7 +1409,7 @@ module.exports = class bibox extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bibox api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchClosedOrders() requires a `symbol` argument'); diff --git a/js/bigone.js b/js/bigone.js index a7f66e4397ce..fa57a2be3ee0 100644 --- a/js/bigone.js +++ b/js/bigone.js @@ -983,7 +983,7 @@ module.exports = class bigone extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bigone api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); diff --git a/js/binance.js b/js/binance.js index 0d551be22018..7754f948ef03 100644 --- a/js/binance.js +++ b/js/binance.js @@ -6240,7 +6240,7 @@ module.exports = class binance extends Exchange { * @description repay borrowed margin and interest * @see https://binance-docs.github.io/apidocs/spot/en/#margin-account-repay-margin * @param {string} code unified currency code of the currency to repay - * @param {float} amount the amount to repay + * @param {number} amount the amount to repay * @param {string|undefined} symbol unified market symbol, required for isolated margin * @param {object} params extra parameters specific to the binance api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} @@ -6287,7 +6287,7 @@ module.exports = class binance extends Exchange { * @description create a loan to borrow margin * @see https://binance-docs.github.io/apidocs/spot/en/#margin-account-borrow-margin * @param {string} code unified currency code of the currency to borrow - * @param {float} amount the amount to borrow + * @param {number} amount the amount to borrow * @param {string|undefined} symbol unified market symbol, required for isolated margin * @param {object} params extra parameters specific to the binance api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} diff --git a/js/bitfinex.js b/js/bitfinex.js index 81125f4979c5..c1a5c5e564f6 100644 --- a/js/bitfinex.js +++ b/js/bitfinex.js @@ -1195,7 +1195,7 @@ module.exports = class bitfinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitfinex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; diff --git a/js/bitfinex2.js b/js/bitfinex2.js index 87cc1013a64b..c8aaf679e9c1 100644 --- a/js/bitfinex2.js +++ b/js/bitfinex2.js @@ -1833,7 +1833,7 @@ module.exports = class bitfinex2 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitfinex2 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ // returns the most recent closed or canceled orders up to circa two weeks ago await this.loadMarkets (); diff --git a/js/bitflyer.js b/js/bitflyer.js index 64fc0f1e2cf6..e6c34242a870 100644 --- a/js/bitflyer.js +++ b/js/bitflyer.js @@ -624,7 +624,7 @@ module.exports = class bitflyer extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitflyer api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a `symbol` argument'); diff --git a/js/bitforex.js b/js/bitforex.js index cd85132fbbf7..4f12c2300491 100644 --- a/js/bitforex.js +++ b/js/bitforex.js @@ -611,7 +611,7 @@ module.exports = class bitforex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitforex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const market = this.market (symbol); diff --git a/js/bitget.js b/js/bitget.js index 435be54eff2e..4847db738414 100644 --- a/js/bitget.js +++ b/js/bitget.js @@ -2281,7 +2281,7 @@ module.exports = class bitget extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitget api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchClosedOrders() requires a symbol argument'); diff --git a/js/bitmex.js b/js/bitmex.js index 6642b17be65d..58aa10bda3d5 100644 --- a/js/bitmex.js +++ b/js/bitmex.js @@ -645,7 +645,7 @@ module.exports = class bitmex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitmex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; diff --git a/js/bitopro.js b/js/bitopro.js index 81bff9c1ae9f..f8a930aa1d0d 100644 --- a/js/bitopro.js +++ b/js/bitopro.js @@ -267,7 +267,7 @@ module.exports = class bitopro extends Exchange { * @name bitopro#fetchMarkets * @description retrieves data on all markets for bitopro * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetProvisioningTradingPairs (); const markets = this.safeValue (response, 'data', []); @@ -596,7 +596,7 @@ module.exports = class bitopro extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the bitopro api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -975,8 +975,8 @@ module.exports = class bitopro extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 bitopro api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1092,7 +1092,7 @@ module.exports = class bitopro extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 bitopro api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1174,7 +1174,7 @@ module.exports = class bitopro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitopro api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires the symbol argument'); @@ -1244,7 +1244,7 @@ module.exports = class bitopro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitopro api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'statusKind': 'DONE', @@ -1261,7 +1261,7 @@ module.exports = class bitopro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the bitopro api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires the symbol argument'); @@ -1397,7 +1397,7 @@ module.exports = class bitopro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the bitopro api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchDeposits() requires the code argument'); @@ -1449,7 +1449,7 @@ module.exports = class bitopro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the bitopro api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires the code argument'); @@ -1537,7 +1537,7 @@ module.exports = class bitopro extends Exchange { * @name bitopro#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the bitopro api endpoint diff --git a/js/bitpanda.js b/js/bitpanda.js index ce5aa3e2db84..a54b3b40367c 100644 --- a/js/bitpanda.js +++ b/js/bitpanda.js @@ -354,7 +354,7 @@ module.exports = class bitpanda extends Exchange { * @name bitpanda#fetchMarkets * @description retrieves data on all markets for bitpanda * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetInstruments (params); // @@ -951,7 +951,7 @@ module.exports = class bitpanda extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the bitpanda api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1107,7 +1107,7 @@ module.exports = class bitpanda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the bitpanda api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1172,7 +1172,7 @@ module.exports = class bitpanda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the bitpanda api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1235,7 +1235,7 @@ module.exports = class bitpanda extends Exchange { * @name bitpanda#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the bitpanda api endpoint @@ -1509,8 +1509,8 @@ module.exports = class bitpanda extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 bitpanda api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1603,7 +1603,7 @@ module.exports = class bitpanda extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 bitpanda api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1710,7 +1710,7 @@ module.exports = class bitpanda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the bitpanda api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1831,7 +1831,7 @@ module.exports = class bitpanda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitpanda api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'with_cancelled_and_rejected': true, // default is false, orders which have been cancelled by the user before being filled or rejected by the system as invalid, additionally, all inactive filled orders which would return with "with_just_filled_inactive" @@ -1849,7 +1849,7 @@ module.exports = class bitpanda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the bitpanda api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1908,7 +1908,7 @@ module.exports = class bitpanda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the bitpanda api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { diff --git a/js/bitrue.js b/js/bitrue.js index 77f8664070cc..bb1109f7db5c 100644 --- a/js/bitrue.js +++ b/js/bitrue.js @@ -566,7 +566,7 @@ module.exports = class bitrue extends Exchange { * @name bitrue#fetchMarkets * @description retrieves data on all markets for bitrue * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.v1PublicGetExchangeInfo (params); // @@ -1042,7 +1042,7 @@ module.exports = class bitrue extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the bitrue api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1212,8 +1212,8 @@ module.exports = class bitrue extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 bitrue api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1300,7 +1300,7 @@ module.exports = class bitrue extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitrue api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchClosedOrders() requires a symbol argument'); @@ -1355,7 +1355,7 @@ module.exports = class bitrue extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the bitrue api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -1440,7 +1440,7 @@ module.exports = class bitrue extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the bitrue api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const method = this.safeString (this.options, 'fetchMyTradesMethod', 'v2PrivateGetMyTrades'); if ((symbol === undefined) && (method === 'v2PrivateGetMyTrades')) { @@ -1496,7 +1496,7 @@ module.exports = class bitrue extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the bitrue api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchDeposits() requires a code argument'); @@ -1568,7 +1568,7 @@ module.exports = class bitrue extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the bitrue api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires a code argument'); @@ -1756,7 +1756,7 @@ module.exports = class bitrue extends Exchange { * @name bitrue#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the bitrue api endpoint diff --git a/js/bittrex.js b/js/bittrex.js index 1ca6748296e6..3b5bc7263046 100644 --- a/js/bittrex.js +++ b/js/bittrex.js @@ -290,7 +290,7 @@ module.exports = class bittrex extends Exchange { * @name bittrex#fetchMarkets * @description retrieves data on all markets for bittrex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetMarkets (params); // @@ -767,7 +767,7 @@ module.exports = class bittrex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the bittrex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -954,7 +954,7 @@ module.exports = class bittrex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the bittrex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1026,7 +1026,7 @@ module.exports = class bittrex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the bittrex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1048,8 +1048,8 @@ module.exports = class bittrex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 bittrex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1314,7 +1314,7 @@ module.exports = class bittrex extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 bittrex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1387,7 +1387,7 @@ module.exports = class bittrex extends Exchange { * @param {number|undefined} params.endDate Filters out result after this timestamp. Uses ISO-8602 format. * @param {string|undefined} params.nextPageToken The unique identifier of the item that the resulting query result should start after, in the sort order of the given endpoint. Used for traversing a paginated set in the forward direction. * @param {string|undefined} params.previousPageToken The unique identifier of the item that the resulting query result should end before, in the sort order of the given endpoint. Used for traversing a paginated set in the reverse direction. - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); // https://support.bittrex.com/hc/en-us/articles/115003723911 @@ -1433,7 +1433,7 @@ module.exports = class bittrex extends Exchange { * @param {number|undefined} params.endDate Filters out result after this timestamp. Uses ISO-8602 format. * @param {string|undefined} params.nextPageToken The unique identifier of the item that the resulting query result should start after, in the sort order of the given endpoint. Used for traversing a paginated set in the forward direction. * @param {string|undefined} params.previousPageToken The unique identifier of the item that the resulting query result should end before, in the sort order of the given endpoint. Used for traversing a paginated set in the reverse direction. - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); return this.fetchDeposits (code, since, limit, this.extend (params, { 'status': 'pending' })); @@ -1470,7 +1470,7 @@ module.exports = class bittrex extends Exchange { * @param {number|undefined} params.endDate Filters out result after this timestamp. Uses ISO-8602 format. * @param {string|undefined} params.nextPageToken The unique identifier of the item that the resulting query result should start after, in the sort order of the given endpoint. Used for traversing a paginated set in the forward direction. * @param {string|undefined} params.previousPageToken The unique identifier of the item that the resulting query result should end before, in the sort order of the given endpoint. Used for traversing a paginated set in the reverse direction. - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); // https://support.bittrex.com/hc/en-us/articles/115003723911 @@ -1513,7 +1513,7 @@ module.exports = class bittrex extends Exchange { * @param {number|undefined} params.endDate Filters out result after this timestamp. Uses ISO-8602 format. * @param {string|undefined} params.nextPageToken The unique identifier of the item that the resulting query result should start after, in the sort order of the given endpoint. Used for traversing a paginated set in the forward direction. * @param {string|undefined} params.previousPageToken The unique identifier of the item that the resulting query result should end before, in the sort order of the given endpoint. Used for traversing a paginated set in the reverse direction. - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); return this.fetchWithdrawals (code, since, limit, this.extend (params, { 'status': 'pending' })); @@ -1848,7 +1848,7 @@ module.exports = class bittrex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the bittrex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = {}; @@ -1878,7 +1878,7 @@ module.exports = class bittrex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bittrex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const stop = this.safeValue (params, 'stop'); @@ -2044,7 +2044,7 @@ module.exports = class bittrex extends Exchange { * @name bittrex#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the bittrex api endpoint diff --git a/js/bitvavo.js b/js/bitvavo.js index 46de1d89d743..4653a76c9ffa 100644 --- a/js/bitvavo.js +++ b/js/bitvavo.js @@ -307,7 +307,7 @@ module.exports = class bitvavo extends Exchange { * @name bitvavo#fetchMarkets * @description retrieves data on all markets for bitvavo * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetMarkets (params); const currencies = await this.fetchCurrenciesFromCache (params); @@ -592,7 +592,7 @@ module.exports = class bitvavo extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the bitvavo api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -945,15 +945,15 @@ module.exports = class bitvavo extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 bitvavo api endpoint * @param {string} params.timeInForce "GTC", "IOC", or "PO" - * @param {float} params.stopPrice The price at which a trigger order is triggered at - * @param {float} params.triggerPrice The price at which a trigger order is triggered at + * @param {number} params.stopPrice The price at which a trigger order is triggered at + * @param {number} params.triggerPrice The price at which a trigger order is triggered at * @param {bool} params.postOnly If true, the order will only be posted to the order book and not executed immediately - * @param {float} params.stopLossPrice The price at which a stop loss order is triggered at - * @param {float} params.takeProfitPrice The price at which a take profit order is triggered at + * @param {number} params.stopLossPrice The price at which a stop loss order is triggered at + * @param {number} params.takeProfitPrice The price at which a take profit order is triggered at * @param {string} params.triggerType "price" * @param {string} params.triggerReference "lastTrade", "bestBid", "bestAsk", "midPrice" Only for stop orders: Use this to determine which parameter will trigger the order * @param {string} params.selfTradePrevention "decrementAndCancel", "cancelOldest", "cancelNewest", "cancelBoth" @@ -1123,7 +1123,7 @@ module.exports = class bitvavo extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 bitvavo api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1208,7 +1208,7 @@ module.exports = class bitvavo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bitvavo api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -1278,7 +1278,7 @@ module.exports = class bitvavo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the bitvavo api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1456,7 +1456,7 @@ module.exports = class bitvavo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the bitvavo api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires a symbol argument'); @@ -1504,7 +1504,7 @@ module.exports = class bitvavo extends Exchange { * @name bitvavo#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the bitvavo api endpoint @@ -1544,7 +1544,7 @@ module.exports = class bitvavo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the bitvavo api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1591,7 +1591,7 @@ module.exports = class bitvavo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the bitvavo api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { diff --git a/js/bkex.js b/js/bkex.js index 96aa80b71f9d..f6722c20d483 100644 --- a/js/bkex.js +++ b/js/bkex.js @@ -231,7 +231,7 @@ module.exports = class bkex extends Exchange { * @name bkex#fetchMarkets * @description retrieves data on all markets for bkex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetCommonSymbols (params); // @@ -645,7 +645,7 @@ module.exports = class bkex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the bkex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -846,7 +846,7 @@ module.exports = class bkex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the bkex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchDeposits() requires code argument'); @@ -904,7 +904,7 @@ module.exports = class bkex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the bkex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires code argument'); @@ -1014,8 +1014,8 @@ module.exports = class bkex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 bkex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1111,7 +1111,7 @@ module.exports = class bkex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the bkex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -1211,7 +1211,7 @@ module.exports = class bkex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bkex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchClosedOrders() requires a symbol argument'); diff --git a/js/blockchaincom.js b/js/blockchaincom.js index 79769c230654..cae7f2b82c9e 100644 --- a/js/blockchaincom.js +++ b/js/blockchaincom.js @@ -181,7 +181,7 @@ module.exports = class blockchaincom extends Exchange { * @name blockchaincom#fetchMarkets * @description retrieves data on all markets for blockchaincom * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ // // "USDC-GBP": { @@ -498,8 +498,8 @@ module.exports = class blockchaincom extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 blockchaincom api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -654,7 +654,7 @@ module.exports = class blockchaincom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the blockchaincom api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const state = 'FILLED'; return await this.fetchOrdersByState (state, symbol, since, limit, params); @@ -669,7 +669,7 @@ module.exports = class blockchaincom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the blockchaincom api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const state = 'OPEN'; return await this.fetchOrdersByState (state, symbol, since, limit, params); @@ -748,7 +748,7 @@ module.exports = class blockchaincom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the blockchaincom api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = {}; @@ -926,7 +926,7 @@ module.exports = class blockchaincom extends Exchange { * @name blockchaincom#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the blockchaincom api endpoint @@ -964,7 +964,7 @@ module.exports = class blockchaincom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the blockchaincom api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1005,7 +1005,7 @@ module.exports = class blockchaincom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the blockchaincom api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { diff --git a/js/btcalpha.js b/js/btcalpha.js index 5105227f4e06..03df38b9e28c 100644 --- a/js/btcalpha.js +++ b/js/btcalpha.js @@ -145,7 +145,7 @@ module.exports = class btcalpha extends Exchange { * @name btcalpha#fetchMarkets * @description retrieves data on all markets for btcalpha * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetPairs (params); // @@ -318,7 +318,7 @@ module.exports = class btcalpha extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the btcalpha api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} */ await this.loadMarkets (); let market = undefined; @@ -343,7 +343,7 @@ module.exports = class btcalpha extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the btcalpha api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const response = await this.privateGetDeposits (params); @@ -369,7 +369,7 @@ module.exports = class btcalpha extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the btcalpha api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); let currency = undefined; @@ -621,8 +621,8 @@ module.exports = class btcalpha extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 btcalpha api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -688,7 +688,7 @@ module.exports = class btcalpha extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the btcalpha api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -713,7 +713,7 @@ module.exports = class btcalpha extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the btcalpha api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': '1', @@ -730,7 +730,7 @@ module.exports = class btcalpha extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the btcalpha api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': '3', @@ -747,7 +747,7 @@ module.exports = class btcalpha extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the btcalpha api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = {}; diff --git a/js/btcbox.js b/js/btcbox.js index 9830b16163c8..ac9e0cbde00b 100644 --- a/js/btcbox.js +++ b/js/btcbox.js @@ -260,7 +260,7 @@ module.exports = class btcbox extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the btcbox api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -292,8 +292,8 @@ module.exports = class btcbox extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 btcbox api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -491,7 +491,7 @@ module.exports = class btcbox extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the btcbox api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByType ('all', symbol, since, limit, params); } @@ -505,7 +505,7 @@ module.exports = class btcbox extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the btcbox api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByType ('open', symbol, since, limit, params); } diff --git a/js/btcmarkets.js b/js/btcmarkets.js index 321e2820b081..ba469c070f52 100644 --- a/js/btcmarkets.js +++ b/js/btcmarkets.js @@ -206,7 +206,7 @@ module.exports = class btcmarkets extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the btcmarkets api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactionsWithMethod ('privateGetDeposits', code, since, limit, params); } @@ -220,7 +220,7 @@ module.exports = class btcmarkets extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the btcmarkets api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactionsWithMethod ('privateGetWithdrawals', code, since, limit, params); } @@ -351,7 +351,7 @@ module.exports = class btcmarkets extends Exchange { * @name btcmarkets#fetchMarkets * @description retrieves data on all markets for btcmarkets * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetMarkets (params); // @@ -751,7 +751,7 @@ module.exports = class btcmarkets extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the btcmarkets api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -778,8 +778,8 @@ module.exports = class btcmarkets extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 btcmarkets api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1028,7 +1028,7 @@ module.exports = class btcmarkets extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the btcmarkets api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1058,7 +1058,7 @@ module.exports = class btcmarkets extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the btcmarkets api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'open' }; return await this.fetchOrders (symbol, since, limit, this.extend (request, params)); @@ -1073,7 +1073,7 @@ module.exports = class btcmarkets extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the btcmarkets api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const orders = await this.fetchOrders (symbol, since, limit, params); return this.filterBy (orders, 'status', 'closed'); @@ -1088,7 +1088,7 @@ module.exports = class btcmarkets extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the btcmarkets api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = {}; @@ -1140,7 +1140,7 @@ module.exports = class btcmarkets extends Exchange { * @name btcmarkets#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the btcmarkets api endpoint diff --git a/js/btcturk.js b/js/btcturk.js index f51ccbba2e2d..f8d409ae125e 100644 --- a/js/btcturk.js +++ b/js/btcturk.js @@ -127,7 +127,7 @@ module.exports = class btcturk extends Exchange { * @name btcturk#fetchMarkets * @description retrieves data on all markets for btcturk * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetServerExchangeinfo (params); // @@ -484,7 +484,7 @@ module.exports = class btcturk extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the btcturk api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -573,8 +573,8 @@ module.exports = class btcturk extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 btcturk api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -624,7 +624,7 @@ module.exports = class btcturk extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the btcturk api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -649,7 +649,7 @@ module.exports = class btcturk extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the btcturk api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const market = this.market (symbol); @@ -774,7 +774,7 @@ module.exports = class btcturk extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the btcturk api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; diff --git a/js/buda.js b/js/buda.js index 6df86d13f532..d8ce9fe41c43 100644 --- a/js/buda.js +++ b/js/buda.js @@ -225,7 +225,7 @@ module.exports = class buda extends Exchange { * @name buda#fetchMarkets * @description retrieves data on all markets for buda * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const marketsResponse = await this.publicGetMarkets (params); // @@ -536,7 +536,7 @@ module.exports = class buda extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the buda api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -706,7 +706,7 @@ module.exports = class buda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the buda api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -731,7 +731,7 @@ module.exports = class buda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the buda api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'state': 'pending', @@ -748,7 +748,7 @@ module.exports = class buda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the buda api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'state': 'traded', @@ -764,8 +764,8 @@ module.exports = class buda extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 buda api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1033,7 +1033,7 @@ module.exports = class buda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the buda api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); if (code === undefined) { @@ -1058,7 +1058,7 @@ module.exports = class buda extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the buda api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); if (code === undefined) { @@ -1080,7 +1080,7 @@ module.exports = class buda extends Exchange { * @name buda#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the buda api endpoint diff --git a/js/bw.js b/js/bw.js index fd99b29982e7..935b413eac43 100644 --- a/js/bw.js +++ b/js/bw.js @@ -149,7 +149,7 @@ module.exports = class bw extends Exchange { * @name bw#fetchMarkets * @description retrieves data on all markets for bw * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetExchangeConfigControllerWebsiteMarketcontrollerGetByWebId (params); // @@ -584,7 +584,7 @@ module.exports = class bw extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the bw api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -798,8 +798,8 @@ module.exports = class bw extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 bw api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1010,7 +1010,7 @@ module.exports = class bw extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the bw api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -1067,7 +1067,7 @@ module.exports = class bw extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bw api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchClosedOrders() requires a symbol argument'); @@ -1098,7 +1098,7 @@ module.exports = class bw extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bw api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -1318,7 +1318,7 @@ module.exports = class bw extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the bw api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchDeposits() requires a currency code argument'); @@ -1372,7 +1372,7 @@ module.exports = class bw extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the bw api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires a currency code argument'); diff --git a/js/bybit.js b/js/bybit.js index c2ccb0eae809..f2bbbd91c71d 100644 --- a/js/bybit.js +++ b/js/bybit.js @@ -650,7 +650,7 @@ module.exports = class bybit extends Exchange { * @name bybit#fetchMarkets * @description retrieves data on all markets for bybit * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ if (this.options['adjustForTimeDifference']) { await this.loadTimeDifference (); @@ -1997,7 +1997,7 @@ module.exports = class bybit extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the bybit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -2726,8 +2726,8 @@ module.exports = class bybit extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 bybit api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -3291,7 +3291,7 @@ module.exports = class bybit extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 bybit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -3412,7 +3412,7 @@ module.exports = class bybit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bybit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -3553,7 +3553,7 @@ module.exports = class bybit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bybit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ let market = undefined; let isUsdcSettled = undefined; @@ -3625,7 +3625,7 @@ module.exports = class bybit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the bybit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ let market = undefined; let isUsdcSettled = undefined; @@ -3718,7 +3718,7 @@ module.exports = class bybit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the bybit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const request = { 'order_id': id, @@ -3735,7 +3735,7 @@ module.exports = class bybit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the bybit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires a symbol argument'); @@ -4016,7 +4016,7 @@ module.exports = class bybit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the bybit api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -4085,7 +4085,7 @@ module.exports = class bybit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the bybit api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -4362,7 +4362,7 @@ module.exports = class bybit extends Exchange { * @name bybit#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the bybit api endpoint @@ -4411,7 +4411,7 @@ module.exports = class bybit extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the bybit api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const request = {}; @@ -4724,7 +4724,7 @@ module.exports = class bybit extends Exchange { * @method * @name bybit#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the bybit api endpoint * @returns {object} response from the exchange diff --git a/js/bytetrade.js b/js/bytetrade.js index 7756e2ee4ecb..4f4932349aeb 100644 --- a/js/bytetrade.js +++ b/js/bytetrade.js @@ -277,7 +277,7 @@ module.exports = class bytetrade extends Exchange { * @name bytetrade#fetchMarkets * @description retrieves data on all markets for bytetrade * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const markets = await this.publicGetSymbols (params); // @@ -721,7 +721,7 @@ module.exports = class bytetrade extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the bytetrade api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -869,8 +869,8 @@ module.exports = class bytetrade extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 bytetrade api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1102,7 +1102,7 @@ module.exports = class bytetrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the bytetrade api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (!('userid' in params) && (this.apiKey === undefined)) { throw new ArgumentsRequired ('fetchOpenOrders() requires this.apiKey or userid argument'); @@ -1135,7 +1135,7 @@ module.exports = class bytetrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bytetrade api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (!('userid' in params) && (this.apiKey === undefined)) { throw new ArgumentsRequired ('fetchClosedOrders() requires this.apiKey or userid argument'); @@ -1168,7 +1168,7 @@ module.exports = class bytetrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the bytetrade api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (!('userid' in params) && (this.apiKey === undefined)) { throw new ArgumentsRequired ('fetchOrders() requires this.apiKey or userid argument'); @@ -1310,7 +1310,7 @@ module.exports = class bytetrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the bytetrade api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (!('userid' in params) && (this.apiKey === undefined)) { throw new ArgumentsRequired ('fetchMyTrades() requires this.apiKey or userid argument'); @@ -1342,7 +1342,7 @@ module.exports = class bytetrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the bytetrade api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); if (!('userid' in params) && (this.apiKey === undefined)) { @@ -1375,7 +1375,7 @@ module.exports = class bytetrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the bytetrade api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); if (!('userid' in params) && (this.apiKey === undefined)) { diff --git a/js/cdax.js b/js/cdax.js index f3022efdd834..11b043b9181f 100644 --- a/js/cdax.js +++ b/js/cdax.js @@ -353,7 +353,7 @@ module.exports = class cdax extends Exchange { * @name cdax#fetchMarkets * @description retrieves data on all markets for cdax * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetCommonSymbols (params); // @@ -773,7 +773,7 @@ module.exports = class cdax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the cdax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -792,7 +792,7 @@ module.exports = class cdax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the cdax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -821,7 +821,7 @@ module.exports = class cdax extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the cdax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1143,7 +1143,7 @@ module.exports = class cdax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the cdax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStates ('pre-submitted,submitted,partial-filled,filled,partial-canceled,canceled', symbol, since, limit, params); } @@ -1157,7 +1157,7 @@ module.exports = class cdax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the cdax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const method = this.safeString (this.options, 'fetchOpenOrdersMethod', 'fetch_open_orders_v1'); return await this[method] (symbol, since, limit, params); @@ -1179,7 +1179,7 @@ module.exports = class cdax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the cdax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStates ('filled,partial-canceled,canceled', symbol, since, limit, params); } @@ -1343,8 +1343,8 @@ module.exports = class cdax extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 cdax api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1494,7 +1494,7 @@ module.exports = class cdax extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 cdax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1575,7 +1575,7 @@ module.exports = class cdax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the cdax api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (limit === undefined || limit > 100) { limit = 100; @@ -1609,7 +1609,7 @@ module.exports = class cdax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the cdax api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (limit === undefined || limit > 100) { limit = 100; @@ -1741,7 +1741,7 @@ module.exports = class cdax extends Exchange { * @name cdax#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the cdax api endpoint diff --git a/js/cex.js b/js/cex.js index 78d62604e005..37df3e06918f 100644 --- a/js/cex.js +++ b/js/cex.js @@ -318,7 +318,7 @@ module.exports = class cex extends Exchange { * @name cex#fetchMarkets * @description retrieves data on all markets for cex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const currenciesResponse = await this.fetchCurrenciesFromCache (params); const currenciesData = this.safeValue (currenciesResponse, 'data', {}); @@ -669,7 +669,7 @@ module.exports = class cex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the cex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -730,8 +730,8 @@ module.exports = class cex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 cex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1083,7 +1083,7 @@ module.exports = class cex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the cex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1110,7 +1110,7 @@ module.exports = class cex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the cex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const method = 'privatePostArchivedOrdersPair'; @@ -1250,7 +1250,7 @@ module.exports = class cex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the cex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const market = this.market (symbol); diff --git a/js/coinbasepro.js b/js/coinbasepro.js index 1cc3c1124089..19ed98b87e14 100644 --- a/js/coinbasepro.js +++ b/js/coinbasepro.js @@ -297,7 +297,7 @@ module.exports = class coinbasepro extends Exchange { * @name coinbasepro#fetchMarkets * @description retrieves data on all markets for coinbasepro * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetProducts (params); // @@ -782,7 +782,7 @@ module.exports = class coinbasepro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the coinbasepro api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ // as of 2018-08-23 if (symbol === undefined) { @@ -809,7 +809,7 @@ module.exports = class coinbasepro extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the coinbasepro api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1058,7 +1058,7 @@ module.exports = class coinbasepro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the coinbasepro api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -1081,7 +1081,7 @@ module.exports = class coinbasepro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the coinbasepro api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'all', @@ -1098,7 +1098,7 @@ module.exports = class coinbasepro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the coinbasepro api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1123,7 +1123,7 @@ module.exports = class coinbasepro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the coinbasepro api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'done', @@ -1139,8 +1139,8 @@ module.exports = class coinbasepro extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 coinbasepro api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1263,7 +1263,7 @@ module.exports = class coinbasepro extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 coinbasepro api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1285,7 +1285,7 @@ module.exports = class coinbasepro extends Exchange { * @name coinbasepro#deposit * @description Creates a new deposit address, as required by coinbasepro * @param {string} code Unified CCXT currency code (e.g. `"USDT"`) - * @param {float} amount The amount of currency to send in the deposit (e.g. `20`) + * @param {number} amount The amount of currency to send in the deposit (e.g. `20`) * @param {string} address Not used by coinbasepro * @param {object} params Parameters specific to the exchange API endpoint (e.g. `{"network": "TRX"}`) * @returns a [transaction structure]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} @@ -1325,7 +1325,7 @@ module.exports = class coinbasepro extends Exchange { * @name coinbasepro#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the coinbasepro api endpoint @@ -1547,7 +1547,7 @@ module.exports = class coinbasepro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the coinbasepro api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactions (code, since, limit, this.extend ({ 'type': 'deposit' }, params)); } @@ -1561,7 +1561,7 @@ module.exports = class coinbasepro extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the coinbasepro api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactions (code, since, limit, this.extend ({ 'type': 'withdraw' }, params)); } diff --git a/js/coinex.js b/js/coinex.js index c00e83fcc72e..85b95caf2ff5 100644 --- a/js/coinex.js +++ b/js/coinex.js @@ -394,7 +394,7 @@ module.exports = class coinex extends Exchange { * @name coinex#fetchMarkets * @description retrieves data on all markets for coinex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ let result = []; const [ type, query ] = this.handleMarketTypeAndParams ('fetchMarkets', undefined, params); @@ -1050,7 +1050,7 @@ module.exports = class coinex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1713,13 +1713,13 @@ module.exports = class coinex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 coinex api endpoint - * @param {float} triggerPrice price at which to triger stop orders - * @param {float} stopPrice price at which to triger stop orders - * @param {float} stopLossPrice price at which to trigger stop-loss orders - * @param {float} takeProfitPrice price at which to trigger take-profit orders + * @param {number} triggerPrice price at which to triger stop orders + * @param {number} stopPrice price at which to triger stop orders + * @param {number} stopLossPrice price at which to trigger stop-loss orders + * @param {number} takeProfitPrice price at which to trigger take-profit orders * @param {string} params.timeInForce "GTC", "IOC", "FOK", "PO" * @param {bool} params.postOnly * @param {bool} params.reduceOnly @@ -2108,7 +2108,7 @@ module.exports = class coinex extends Exchange { * @description cancel all open orders in a market * @param {string} symbol unified market symbol of the market to cancel orders in * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' cancellAllOrders() requires a symbol argument'); @@ -2499,7 +2499,7 @@ module.exports = class coinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStatus ('pending', symbol, since, limit, params); } @@ -2513,7 +2513,7 @@ module.exports = class coinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStatus ('finished', symbol, since, limit, params); } @@ -2645,7 +2645,7 @@ module.exports = class coinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -2781,7 +2781,7 @@ module.exports = class coinex extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const request = {}; @@ -3098,7 +3098,7 @@ module.exports = class coinex extends Exchange { * @method * @name coinex#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the coinex api endpoint * @returns {object} response from the exchange @@ -3309,7 +3309,7 @@ module.exports = class coinex extends Exchange { * @name coinex#addMargin * @description add margin * @param {string} symbol unified market symbol - * @param {float} amount amount of margin to add + * @param {number} amount amount of margin to add * @param {object} params extra parameters specific to the coinex api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#add-margin-structure} */ @@ -3322,7 +3322,7 @@ module.exports = class coinex extends Exchange { * @name coinex#reduceMargin * @description remove margin from a position * @param {string} symbol unified market symbol - * @param {float} amount the amount of margin to remove + * @param {number} amount the amount of margin to remove * @param {object} params extra parameters specific to the coinex api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#reduce-margin-structure} */ @@ -3514,7 +3514,7 @@ module.exports = class coinex extends Exchange { * @name coinex#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the coinex api endpoint @@ -3579,7 +3579,7 @@ module.exports = class coinex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest funding rate to fetch * @param {number|undefined} limit the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} to fetch * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} + * @returns {[object]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchFundingRateHistory() requires a symbol argument'); @@ -3735,7 +3735,7 @@ module.exports = class coinex extends Exchange { * @name coinex#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the coinex api endpoint @@ -3849,7 +3849,7 @@ module.exports = class coinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch transfers for * @param {number|undefined} limit the maximum number of transfers structures to retrieve * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} + * @returns {[object]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} */ await this.loadMarkets (); let currency = undefined; @@ -3934,7 +3934,7 @@ module.exports = class coinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires a currency code argument'); @@ -4002,7 +4002,7 @@ module.exports = class coinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the coinex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchDeposits() requires a currency code argument'); @@ -4272,7 +4272,7 @@ module.exports = class coinex extends Exchange { * @description create a loan to borrow margin * @see https://github.com/coinexcom/coinex_exchange_api/wiki/086margin_loan * @param {string} code unified currency code of the currency to borrow - * @param {float} amount the amount to borrow + * @param {number} amount the amount to borrow * @param {string} symbol unified market symbol, required for coinex * @param {object} params extra parameters specific to the coinex api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} @@ -4313,7 +4313,7 @@ module.exports = class coinex extends Exchange { * @description repay borrowed margin and interest * @see https://github.com/coinexcom/coinex_exchange_api/wiki/087margin_flat * @param {string} code unified currency code of the currency to repay - * @param {float} amount the amount to repay + * @param {number} amount the amount to repay * @param {string} symbol unified market symbol, required for coinex * @param {object} params extra parameters specific to the coinex api endpoint * @param {string|undefined} params.loan_id extra parameter that is not required diff --git a/js/coinmate.js b/js/coinmate.js index 890d8391c864..d2571063a5b7 100644 --- a/js/coinmate.js +++ b/js/coinmate.js @@ -204,7 +204,7 @@ module.exports = class coinmate extends Exchange { * @name coinmate#fetchMarkets * @description retrieves data on all markets for coinmate * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetTradingPairs (params); // @@ -508,7 +508,7 @@ module.exports = class coinmate extends Exchange { * @name coinmate#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the coinmate api endpoint @@ -565,7 +565,7 @@ module.exports = class coinmate extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the coinmate api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); if (limit === undefined) { @@ -659,7 +659,7 @@ module.exports = class coinmate extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the coinmate api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -734,7 +734,7 @@ module.exports = class coinmate extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the coinmate api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const response = await this.privatePostOpenOrders (this.extend ({}, params)); const extension = { 'status': 'open' }; @@ -750,7 +750,7 @@ module.exports = class coinmate extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the coinmate api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -875,8 +875,8 @@ module.exports = class coinmate extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 coinmate api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ diff --git a/js/crex24.js b/js/crex24.js index 3623b5ddd791..fe2bad2471dd 100644 --- a/js/crex24.js +++ b/js/crex24.js @@ -241,7 +241,7 @@ module.exports = class crex24 extends Exchange { * @name crex24#fetchMarkets * @description retrieves data on all markets for crex24 * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetInstruments (params); // @@ -802,7 +802,7 @@ module.exports = class crex24 extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the crex24 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1073,8 +1073,8 @@ module.exports = class crex24 extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 crex24 api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1191,7 +1191,7 @@ module.exports = class crex24 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the crex24 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1270,7 +1270,7 @@ module.exports = class crex24 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the crex24 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1331,7 +1331,7 @@ module.exports = class crex24 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the crex24 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1441,7 +1441,7 @@ module.exports = class crex24 extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 crex24 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ let response = undefined; let market = undefined; @@ -1480,7 +1480,7 @@ module.exports = class crex24 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the crex24 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1526,7 +1526,7 @@ module.exports = class crex24 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the crex24 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -1643,7 +1643,7 @@ module.exports = class crex24 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the crex24 api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'type': 'deposit', @@ -1660,7 +1660,7 @@ module.exports = class crex24 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the crex24 api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'type': 'withdrawal', @@ -1773,7 +1773,7 @@ module.exports = class crex24 extends Exchange { * @name crex24#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the crex24 api endpoint diff --git a/js/cryptocom.js b/js/cryptocom.js index 3733cd9fcb47..fe0d9ebe6eb1 100644 --- a/js/cryptocom.js +++ b/js/cryptocom.js @@ -289,7 +289,7 @@ module.exports = class cryptocom extends Exchange { * @name cryptocom#fetchMarkets * @description retrieves data on all markets for cryptocom * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ // // { @@ -569,7 +569,7 @@ module.exports = class cryptocom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the cryptocom api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -677,7 +677,7 @@ module.exports = class cryptocom extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the cryptocom api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1029,8 +1029,8 @@ module.exports = class cryptocom extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 cryptocom api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1078,7 +1078,7 @@ module.exports = class cryptocom extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 cryptocom api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1148,7 +1148,7 @@ module.exports = class cryptocom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the cryptocom api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1226,7 +1226,7 @@ module.exports = class cryptocom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the cryptocom api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = {}; @@ -1297,7 +1297,7 @@ module.exports = class cryptocom extends Exchange { * @name cryptocom#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the cryptocom api endpoint @@ -1436,7 +1436,7 @@ module.exports = class cryptocom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the cryptocom api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); let currency = undefined; @@ -1486,7 +1486,7 @@ module.exports = class cryptocom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the cryptocom api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); let currency = undefined; @@ -1537,7 +1537,7 @@ module.exports = class cryptocom extends Exchange { * @name cryptocom#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the cryptocom api endpoint @@ -1580,7 +1580,7 @@ module.exports = class cryptocom extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch transfers for * @param {number|undefined} limit the maximum number of transfers structures to retrieve * @param {object} params extra parameters specific to the cryptocom api endpoint - * @returns {[dict]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} + * @returns {[object]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} */ if (!('direction' in params)) { throw new ArgumentsRequired (this.id + ' fetchTransfers() requires a direction param to be either "IN" or "OUT"'); @@ -2083,7 +2083,7 @@ module.exports = class cryptocom extends Exchange { * @description repay borrowed margin and interest * @see https://exchange-docs.crypto.com/spot/index.html#private-margin-repay * @param {string} code unified currency code of the currency to repay - * @param {float} amount the amount to repay + * @param {number} amount the amount to repay * @param {string|undefined} symbol unified market symbol, not used by cryptocom.repayMargin () * @param {object} params extra parameters specific to the cryptocom api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} @@ -2118,7 +2118,7 @@ module.exports = class cryptocom extends Exchange { * @description create a loan to borrow margin * @see https://exchange-docs.crypto.com/spot/index.html#private-margin-borrow * @param {string} code unified currency code of the currency to borrow - * @param {float} amount the amount to borrow + * @param {number} amount the amount to borrow * @param {string|undefined} symbol unified market symbol, not used by cryptocom.repayMargin () * @param {object} params extra parameters specific to the cryptocom api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} diff --git a/js/delta.js b/js/delta.js index 31d723dbb37d..6f40295085fc 100644 --- a/js/delta.js +++ b/js/delta.js @@ -375,7 +375,7 @@ module.exports = class delta extends Exchange { * @name delta#fetchMarkets * @description retrieves data on all markets for delta * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetProducts (params); // @@ -962,7 +962,7 @@ module.exports = class delta extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the delta api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1141,7 +1141,7 @@ module.exports = class delta extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the delta api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const response = await this.privateGetPositionsMargined (params); @@ -1271,8 +1271,8 @@ module.exports = class delta extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 delta api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1443,7 +1443,7 @@ module.exports = class delta extends Exchange { * @description cancel all open orders in a market * @param {string} symbol unified market symbol of the market to cancel orders in * @param {object} params extra parameters specific to the delta api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' cancelAllOrders() requires a symbol argument'); @@ -1474,7 +1474,7 @@ module.exports = class delta extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the delta api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersWithMethod ('privateGetOrders', symbol, since, limit, params); } @@ -1488,7 +1488,7 @@ module.exports = class delta extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the delta api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersWithMethod ('privateGetOrdersHistory', symbol, since, limit, params); } @@ -1553,7 +1553,7 @@ module.exports = class delta extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the delta api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { diff --git a/js/deribit.js b/js/deribit.js index 899132a9066b..744f664ec320 100644 --- a/js/deribit.js +++ b/js/deribit.js @@ -523,7 +523,7 @@ module.exports = class deribit extends Exchange { * @name deribit#fetchMarkets * @description retrieves data on all markets for deribit * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const currenciesResponse = await this.publicGetGetCurrencies (params); // @@ -1208,7 +1208,7 @@ module.exports = class deribit extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the deribit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1604,8 +1604,8 @@ module.exports = class deribit extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 deribit api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1767,7 +1767,7 @@ module.exports = class deribit extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 deribit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1792,7 +1792,7 @@ module.exports = class deribit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the deribit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1822,7 +1822,7 @@ module.exports = class deribit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the deribit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1853,7 +1853,7 @@ module.exports = class deribit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the deribit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1906,7 +1906,7 @@ module.exports = class deribit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the deribit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1985,7 +1985,7 @@ module.exports = class deribit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the deribit api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchDeposits() requires a currency code argument'); @@ -2033,7 +2033,7 @@ module.exports = class deribit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the deribit api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchWithdrawals() requires a currency code argument'); @@ -2265,7 +2265,7 @@ module.exports = class deribit extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the deribit api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); let code = undefined; @@ -2368,7 +2368,7 @@ module.exports = class deribit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch transfers for * @param {number|undefined} limit the maximum number of transfers structures to retrieve * @param {object} params extra parameters specific to the deribit api endpoint - * @returns {[dict]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} + * @returns {[object]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} */ if (code === undefined) { throw new ArgumentsRequired (this.id + ' fetchTransfers() requires a currency code argument'); @@ -2426,7 +2426,7 @@ module.exports = class deribit extends Exchange { * @name deribit#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the deribit api endpoint @@ -2515,7 +2515,7 @@ module.exports = class deribit extends Exchange { * @name deribit#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the deribit api endpoint diff --git a/js/digifinex.js b/js/digifinex.js index d4fe93dde052..46253c0161f7 100644 --- a/js/digifinex.js +++ b/js/digifinex.js @@ -320,7 +320,7 @@ module.exports = class digifinex extends Exchange { * @name digifinex#fetchMarkets * @description retrieves data on all markets for digifinex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const options = this.safeValue (this.options, 'fetchMarkets', {}); const method = this.safeString (options, 'method', 'fetch_markets_v2'); @@ -854,7 +854,7 @@ module.exports = class digifinex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the digifinex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -967,8 +967,8 @@ module.exports = class digifinex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 digifinex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1178,7 +1178,7 @@ module.exports = class digifinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the digifinex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const defaultType = this.safeString (this.options, 'defaultType', 'spot'); const orderType = this.safeString (params, 'type', defaultType); @@ -1227,7 +1227,7 @@ module.exports = class digifinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the digifinex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const defaultType = this.safeString (this.options, 'defaultType', 'spot'); const orderType = this.safeString (params, 'type', defaultType); @@ -1333,7 +1333,7 @@ module.exports = class digifinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the digifinex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const defaultType = this.safeString (this.options, 'defaultType', 'spot'); const orderType = this.safeString (params, 'type', defaultType); @@ -1581,7 +1581,7 @@ module.exports = class digifinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the digifinex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactionsByType ('deposit', code, since, limit, params); } @@ -1595,7 +1595,7 @@ module.exports = class digifinex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the digifinex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactionsByType ('withdrawal', code, since, limit, params); } @@ -1707,7 +1707,7 @@ module.exports = class digifinex extends Exchange { * @name digifinex#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the digifinex api endpoint @@ -1745,7 +1745,7 @@ module.exports = class digifinex extends Exchange { * @name digifinex#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the digifinex api endpoint diff --git a/js/eqonex.js b/js/eqonex.js index edb4cd39887b..c84a1218b2cc 100644 --- a/js/eqonex.js +++ b/js/eqonex.js @@ -139,7 +139,7 @@ module.exports = class eqonex extends Exchange { * @name eqonex#fetchMarkets * @description retrieves data on all markets for eqonex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const request = { 'verbose': true, @@ -560,7 +560,7 @@ module.exports = class eqonex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the eqonex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -744,8 +744,8 @@ module.exports = class eqonex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 eqonex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -998,7 +998,7 @@ module.exports = class eqonex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the eqonex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'ordStatus': '2', // '0' = New, '1' = Partially filled, '2' = Filled, '4' = Cancelled, '8' = Rejected, 'C' = Expired @@ -1032,7 +1032,7 @@ module.exports = class eqonex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the eqonex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1110,7 +1110,7 @@ module.exports = class eqonex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the eqonex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1221,7 +1221,7 @@ module.exports = class eqonex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the eqonex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; @@ -1263,7 +1263,7 @@ module.exports = class eqonex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the eqonex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; @@ -1387,7 +1387,7 @@ module.exports = class eqonex extends Exchange { * @name eqonex#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the eqonex api endpoint diff --git a/js/ftx.js b/js/ftx.js index 98f5522efa19..c5448ee63706 100644 --- a/js/ftx.js +++ b/js/ftx.js @@ -473,7 +473,7 @@ module.exports = class ftx extends Exchange { * @name ftx#fetchMarkets * @description retrieves data on all markets for ftx * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetMarkets (params); // @@ -1156,7 +1156,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the ftx api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} */ await this.loadMarkets (); const [ market, marketId ] = this.getMarketParams (symbol, 'market_name', params); @@ -1339,7 +1339,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} limit the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} to fetch * @param {object} params extra parameters specific to the ftx api endpoint * @param {number|undefined} params.until timestamp in ms of the latest funding rate to fetch - * @returns {[dict]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} + * @returns {[object]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} */ await this.loadMarkets (); const request = {}; @@ -1615,8 +1615,8 @@ module.exports = class ftx extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 ftx api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1924,7 +1924,7 @@ module.exports = class ftx extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 ftx api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -2004,7 +2004,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the ftx api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -2062,7 +2062,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the ftx api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -2126,7 +2126,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the ftx api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const request = { 'orderId': id, @@ -2144,7 +2144,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the ftx api endpoint * @param {number|undefined} params.until timestamp in ms of the latest trade - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const [ market, marketId ] = this.getMarketParams (symbol, 'market', params); @@ -2201,7 +2201,7 @@ module.exports = class ftx extends Exchange { * @name ftx#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the ftx api endpoint @@ -2279,7 +2279,7 @@ module.exports = class ftx extends Exchange { * @name ftx#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the ftx api endpoint @@ -2337,7 +2337,7 @@ module.exports = class ftx extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the ftx api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const request = { @@ -2629,7 +2629,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the ftx api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const response = await this.privateGetWalletDeposits (params); @@ -2667,7 +2667,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the ftx api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const response = await this.privateGetWalletWithdrawals (params); @@ -2758,7 +2758,7 @@ module.exports = class ftx extends Exchange { * @method * @name ftx#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string|undefined} symbol not used by ftx setLeverage () * @param {object} params extra parameters specific to the ftx api endpoint * @returns {object} response from the exchange @@ -3030,7 +3030,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} limit the maximum number of [borrow rate structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-rate-structure} to retrieve * @param {object} params extra parameters specific to the exchange api endpoint * @param {number|undefined} params.till Timestamp in ms of the latest time to fetch the borrow rate - * @returns {[dict]} an array of [borrow rate structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-rate-structure} + * @returns {[object]} an array of [borrow rate structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-rate-structure} */ const histories = await this.fetchBorrowRateHistories ([ code ], since, limit, params); const borrowRateHistory = this.safeValue (histories, code); @@ -3110,7 +3110,7 @@ module.exports = class ftx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch borrrow interest for * @param {number|undefined} limit the maximum number of structures to retrieve * @param {object} params extra parameters specific to the ftx api endpoint - * @returns {[dict]} a list of [borrow interest structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-interest-structure} + * @returns {[object]} a list of [borrow interest structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-interest-structure} */ await this.loadMarkets (); const request = {}; diff --git a/js/gate.js b/js/gate.js index d050b9646674..93ca1f49ca9a 100644 --- a/js/gate.js +++ b/js/gate.js @@ -640,7 +640,7 @@ module.exports = class gate extends Exchange { * @name gate#fetchMarkets * @description retrieves data on all markets for gate * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ let result = []; const [ type, query ] = this.handleMarketTypeAndParams ('fetchMarkets', undefined, params); @@ -2291,7 +2291,7 @@ module.exports = class gate extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest funding rate to fetch * @param {number|undefined} limit the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} to fetch * @param {object} params extra parameters specific to the gate api endpoint - * @returns {[dict]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} + * @returns {[object]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchFundingRateHistory() requires a symbol argument'); @@ -2383,7 +2383,7 @@ module.exports = class gate extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the gate api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -2463,7 +2463,7 @@ module.exports = class gate extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the binance api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); if (symbol === undefined) { @@ -2510,7 +2510,7 @@ module.exports = class gate extends Exchange { * @param {number|undefined} params.offset *contract only* list offset, starting from 0 * @param {string|undefined} params.last_id *contract only* specify list staring point using the id of last record in previous list-query results * @param {number|undefined} params.count_total *contract only* whether to return total number matched, default to 0(no return) - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let type = undefined; @@ -2730,7 +2730,7 @@ module.exports = class gate extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the gate api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; @@ -2760,7 +2760,7 @@ module.exports = class gate extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the gate api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; @@ -2787,7 +2787,7 @@ module.exports = class gate extends Exchange { * @name gate#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the gate api endpoint @@ -2919,10 +2919,10 @@ module.exports = class gate extends Exchange { * @param {string} symbol Unified CCXT market symbol * @param {string} type 'limit' or 'market' *"market" is contract only* * @param {string} side 'buy' or 'sell' - * @param {float} amount the amount of currency to trade - * @param {float|undefined} price *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency + * @param {number} amount the amount of currency to trade + * @param {number|undefined} price *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency * @param {object} params Extra parameters specific to the exchange API endpoint - * @param {float|undefined} params.stopPrice The price at which a trigger order is triggered at + * @param {number|undefined} params.stopPrice The price at which a trigger order is triggered at * @param {string|undefined} params.timeInForce "GTC", "IOC", or "PO" * @param {string|undefined} params.marginMode 'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used * @param {number|undefined} params.iceberg Amount to display for the iceberg order, Null or 0 for normal orders, Set to -1 to hide the order completely @@ -3496,7 +3496,7 @@ module.exports = class gate extends Exchange { * @param {bool} params.stop true for fetching stop orders * @param {string} params.type spot, margin, swap or future, if not provided this.options['defaultType'] is used * @param {string} params.marginMode 'cross' or 'isolated' - marginMode for type='margin', if not provided this.options['defaultMarginMode'] is used - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStatus ('open', symbol, since, limit, params); } @@ -3513,7 +3513,7 @@ module.exports = class gate extends Exchange { * @param {bool} params.stop true for fetching stop orders * @param {string} params.type spot, swap or future, if not provided this.options['defaultType'] is used * @param {string} params.marginMode 'cross' or 'isolated' - marginMode for margin trading if not provided this.options['defaultMarginMode'] is used - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStatus ('finished', symbol, since, limit, params); } @@ -3797,7 +3797,7 @@ module.exports = class gate extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 gate api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const market = (symbol === undefined) ? undefined : this.market (symbol); @@ -3850,7 +3850,7 @@ module.exports = class gate extends Exchange { * @name gate#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code for currency being transferred - * @param {float} amount the amount of currency to transfer + * @param {number} amount the amount of currency to transfer * @param {string} fromAccount the account to transfer currency from * @param {string} toAccount the account to transfer currency to * @param {object} params extra parameters specific to the gate api endpoint @@ -3943,7 +3943,7 @@ module.exports = class gate extends Exchange { * @method * @name gate#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the gate api endpoint * @returns {object} response from the exchange @@ -4100,7 +4100,7 @@ module.exports = class gate extends Exchange { * @param {object} params extra parameters specific to the gate api endpoint * @param {string} params.settle 'btc' or 'usdt' - settle currency for perpetual swap and future - default="usdt" for swap and "btc" for future * @param {string} params.type swap or future, if not provided this.options['defaultType'] is used - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const [ type, query ] = this.handleMarketTypeAndParams ('fetchPositions', undefined, params); @@ -4388,7 +4388,7 @@ module.exports = class gate extends Exchange { * @see https://www.gate.io/docs/apiv4/en/#repay-cross-margin-loan * @see https://www.gate.io/docs/apiv4/en/#repay-a-loan * @param {string} code unified currency code of the currency to repay - * @param {float} amount the amount to repay + * @param {number} amount the amount to repay * @param {string|undefined} symbol unified market symbol, required for isolated margin * @param {object} params extra parameters specific to the gate api endpoint * @param {string} params.mode 'all' or 'partial' payment mode, extra parameter required for isolated margin @@ -4479,7 +4479,7 @@ module.exports = class gate extends Exchange { * @see https://www.gate.io/docs/apiv4/en/#create-a-cross-margin-borrow-loan * @see https://www.gate.io/docs/apiv4/en/#lend-or-borrow * @param {string} code unified currency code of the currency to borrow - * @param {float} amount the amount to borrow + * @param {number} amount the amount to borrow * @param {string|undefined} symbol unified market symbol, required for isolated margin * @param {object} params extra parameters specific to the gate api endpoint * @param {string} params.rate '0.0002' or '0.002' extra parameter required for isolated margin diff --git a/js/hitbtc.js b/js/hitbtc.js index d3dae9f80add..8c9154b7e63a 100644 --- a/js/hitbtc.js +++ b/js/hitbtc.js @@ -276,7 +276,7 @@ module.exports = class hitbtc extends Exchange { * @name hitbtc#fetchMarkets * @description retrieves data on all markets for hitbtc * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetSymbol (params); // @@ -372,7 +372,7 @@ module.exports = class hitbtc extends Exchange { * @name hitbtc#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the hitbtc api endpoint @@ -959,7 +959,7 @@ module.exports = class hitbtc extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the hitbtc api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -985,8 +985,8 @@ module.exports = class hitbtc extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 hitbtc api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1219,7 +1219,7 @@ module.exports = class hitbtc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the hitbtc api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1241,7 +1241,7 @@ module.exports = class hitbtc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the hitbtc api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1278,7 +1278,7 @@ module.exports = class hitbtc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the hitbtc api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1341,7 +1341,7 @@ module.exports = class hitbtc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the hitbtc api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ // The id needed here is the exchange's id, and not the clientOrderID, // which is the id that is stored in the unified order id @@ -1448,7 +1448,7 @@ module.exports = class hitbtc extends Exchange { * @name hitbtc#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the hitbtc api endpoint diff --git a/js/hitbtc3.js b/js/hitbtc3.js index 38a4d277150c..090d8a3fcf69 100644 --- a/js/hitbtc3.js +++ b/js/hitbtc3.js @@ -346,7 +346,7 @@ module.exports = class hitbtc3 extends Exchange { * @name hitbtc3#fetchMarkets * @description retrieves data on all markets for hitbtc3 * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetPublicSymbol (params); // @@ -837,7 +837,7 @@ module.exports = class hitbtc3 extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the hitbtc3 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} */ await this.loadMarkets (); let market = undefined; @@ -875,7 +875,7 @@ module.exports = class hitbtc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the hitbtc3 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -1164,7 +1164,7 @@ module.exports = class hitbtc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the hitbtc3 api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactionsHelper ('DEPOSIT', code, since, limit, params); } @@ -1178,7 +1178,7 @@ module.exports = class hitbtc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the hitbtc3 api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactionsHelper ('WITHDRAW', code, since, limit, params); } @@ -1423,7 +1423,7 @@ module.exports = class hitbtc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the hitbtc3 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1506,7 +1506,7 @@ module.exports = class hitbtc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the hitbtc3 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -1573,7 +1573,7 @@ module.exports = class hitbtc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the hitbtc3 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1646,7 +1646,7 @@ module.exports = class hitbtc3 extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 hitbtc3 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1727,8 +1727,8 @@ module.exports = class hitbtc3 extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 hitbtc3 api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1924,7 +1924,7 @@ module.exports = class hitbtc3 extends Exchange { * @name hitbtc3#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the hitbtc3 api endpoint @@ -2019,7 +2019,7 @@ module.exports = class hitbtc3 extends Exchange { * @name hitbtc3#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the hitbtc3 api endpoint @@ -2064,7 +2064,7 @@ module.exports = class hitbtc3 extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest funding rate to fetch * @param {number|undefined} limit the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} to fetch * @param {object} params extra parameters specific to the hitbtc3 api endpoint - * @returns {[dict]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} + * @returns {[object]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} */ await this.loadMarkets (); let market = undefined; @@ -2135,7 +2135,7 @@ module.exports = class hitbtc3 extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols not used by hitbtc3 fetchPositions () * @param {object} params extra parameters specific to the hitbtc3 api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const request = {}; @@ -2469,7 +2469,7 @@ module.exports = class hitbtc3 extends Exchange { * @name hitbtc3#reduceMargin * @description remove margin from a position * @param {string} symbol unified market symbol - * @param {float} amount the amount of margin to remove + * @param {number} amount the amount of margin to remove * @param {object} params extra parameters specific to the hitbtc3 api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#reduce-margin-structure} */ @@ -2485,7 +2485,7 @@ module.exports = class hitbtc3 extends Exchange { * @name hitbtc3#addMargin * @description add margin * @param {string} symbol unified market symbol - * @param {float} amount amount of margin to add + * @param {number} amount amount of margin to add * @param {object} params extra parameters specific to the hitbtc3 api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#add-margin-structure} */ @@ -2550,7 +2550,7 @@ module.exports = class hitbtc3 extends Exchange { * @method * @name hitbtc3#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the hitbtc3 api endpoint * @returns {object} response from the exchange diff --git a/js/hollaex.js b/js/hollaex.js index 060585ca01b6..e1e631069d35 100644 --- a/js/hollaex.js +++ b/js/hollaex.js @@ -204,7 +204,7 @@ module.exports = class hollaex extends Exchange { * @name hollaex#fetchMarkets * @description retrieves data on all markets for hollaex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetConstants (params); // @@ -600,7 +600,7 @@ module.exports = class hollaex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the hollaex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -913,7 +913,7 @@ module.exports = class hollaex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the hollaex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'open': true, @@ -930,7 +930,7 @@ module.exports = class hollaex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the hollaex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'open': false, @@ -990,7 +990,7 @@ module.exports = class hollaex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the hollaex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1135,8 +1135,8 @@ module.exports = class hollaex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 hollaex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1231,7 +1231,7 @@ module.exports = class hollaex extends Exchange { * @description cancel all open orders in a market * @param {string} symbol unified market symbol of the market to cancel orders in * @param {object} params extra parameters specific to the hollaex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + " cancelAllOrders() requires a 'symbol' argument"); @@ -1269,7 +1269,7 @@ module.exports = class hollaex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the hollaex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1415,7 +1415,7 @@ module.exports = class hollaex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the hollaex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1523,7 +1523,7 @@ module.exports = class hollaex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the hollaex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1677,7 +1677,7 @@ module.exports = class hollaex extends Exchange { * @name hollaex#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the hollaex api endpoint diff --git a/js/huobi.js b/js/huobi.js index 94940aa10988..52623373f3f9 100644 --- a/js/huobi.js +++ b/js/huobi.js @@ -1342,7 +1342,7 @@ module.exports = class huobi extends Exchange { * @name huobi#fetchMarkets * @description retrieves data on all markets for huobi * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const options = this.safeValue (this.options, 'fetchMarkets', {}); const types = this.safeValue (options, 'types', {}); @@ -2209,7 +2209,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ let marketType = undefined; [ marketType, params ] = this.handleMarketTypeAndParams ('fetchOrderTrades', undefined, params); @@ -2239,7 +2239,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let marketType = undefined; @@ -2387,7 +2387,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -3462,7 +3462,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let marketType = undefined; @@ -3491,7 +3491,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let marketType = undefined; @@ -3516,7 +3516,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let marketType = undefined; @@ -3939,8 +3939,8 @@ module.exports = class huobi extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 huobi api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -4432,7 +4432,7 @@ module.exports = class huobi extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 huobi api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let marketType = undefined; @@ -4681,7 +4681,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (limit === undefined || limit > 100) { limit = 100; @@ -4715,7 +4715,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (limit === undefined || limit > 100) { limit = 100; @@ -4854,7 +4854,7 @@ module.exports = class huobi extends Exchange { * @name huobi#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the huobi api endpoint @@ -4924,7 +4924,7 @@ module.exports = class huobi extends Exchange { * @name huobi#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the huobi api endpoint @@ -5098,7 +5098,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since not used by huobi, but filtered internally by ccxt * @param {number|undefined} limit not used by huobi, but filtered internally by ccxt * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} + * @returns {[object]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchFundingRateHistory() requires a symbol argument'); @@ -5299,7 +5299,7 @@ module.exports = class huobi extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch borrrow interest for * @param {number|undefined} limit the maximum number of structures to retrieve * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [borrow interest structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-interest-structure} + * @returns {[object]} a list of [borrow interest structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-interest-structure} */ await this.loadMarkets (); const defaultMargin = this.safeString (params, 'marginMode', 'cross'); // cross or isolated @@ -5645,7 +5645,7 @@ module.exports = class huobi extends Exchange { * @method * @name huobi#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the huobi api endpoint * @returns {object} response from the exchange @@ -5842,7 +5842,7 @@ module.exports = class huobi extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the huobi api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const marginMode = this.safeString2 (this.options, 'defaultMarginMode', 'marginMode', 'isolated'); @@ -6617,7 +6617,7 @@ module.exports = class huobi extends Exchange { * @see https://huobiapi.github.io/docs/spot/v1/en/#request-a-margin-loan-isolated * @see https://huobiapi.github.io/docs/spot/v1/en/#request-a-margin-loan-cross * @param {string} code unified currency code of the currency to borrow - * @param {float} amount the amount to borrow + * @param {number} amount the amount to borrow * @param {string|undefined} symbol unified market symbol, required for isolated margin * @param {object} params extra parameters specific to the huobi api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} @@ -6671,7 +6671,7 @@ module.exports = class huobi extends Exchange { * @description repay borrowed margin and interest * @see https://huobiapi.github.io/docs/spot/v1/en/#repay-margin-loan-cross-isolated * @param {string} code unified currency code of the currency to repay - * @param {float} amount the amount to repay + * @param {number} amount the amount to repay * @param {string|undefined} symbol unified market symbol * @param {object} params extra parameters specific to the huobi api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} diff --git a/js/huobijp.js b/js/huobijp.js index 18398035c232..782c9ba9e09f 100644 --- a/js/huobijp.js +++ b/js/huobijp.js @@ -416,7 +416,7 @@ module.exports = class huobijp extends Exchange { * @name huobijp#fetchMarkets * @description retrieves data on all markets for huobijp * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const method = this.options['fetchMarketsMethod']; const response = await this[method] (params); @@ -825,7 +825,7 @@ module.exports = class huobijp extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the huobijp api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -844,7 +844,7 @@ module.exports = class huobijp extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the huobijp api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -873,7 +873,7 @@ module.exports = class huobijp extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the huobijp api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1195,7 +1195,7 @@ module.exports = class huobijp extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the huobijp api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStates ('pre-submitted,submitted,partial-filled,filled,partial-canceled,canceled', symbol, since, limit, params); } @@ -1209,7 +1209,7 @@ module.exports = class huobijp extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the huobijp api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const method = this.safeString (this.options, 'fetchOpenOrdersMethod', 'fetch_open_orders_v1'); return await this[method] (symbol, since, limit, params); @@ -1231,7 +1231,7 @@ module.exports = class huobijp extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the huobijp api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStates ('filled,partial-canceled,canceled', symbol, since, limit, params); } @@ -1392,8 +1392,8 @@ module.exports = class huobijp extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 huobijp api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1547,7 +1547,7 @@ module.exports = class huobijp extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 huobijp api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1628,7 +1628,7 @@ module.exports = class huobijp extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the huobijp api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (limit === undefined || limit > 100) { limit = 100; @@ -1662,7 +1662,7 @@ module.exports = class huobijp extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the huobijp api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ if (limit === undefined || limit > 100) { limit = 100; @@ -1801,7 +1801,7 @@ module.exports = class huobijp extends Exchange { * @name huobijp#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the huobijp api endpoint diff --git a/js/idex.js b/js/idex.js index c1080be8205f..6f1e5bc90e5d 100644 --- a/js/idex.js +++ b/js/idex.js @@ -189,7 +189,7 @@ module.exports = class idex extends Exchange { * @name idex#fetchMarkets * @description retrieves data on all markets for idex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetMarkets (params); // @@ -500,7 +500,7 @@ module.exports = class idex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the idex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -836,7 +836,7 @@ module.exports = class idex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the idex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ this.checkRequiredCredentials (); await this.loadMarkets (); @@ -918,7 +918,7 @@ module.exports = class idex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the idex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'closed': false, @@ -935,7 +935,7 @@ module.exports = class idex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the idex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'closed': true, @@ -1148,8 +1148,8 @@ module.exports = class idex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 idex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1339,7 +1339,7 @@ module.exports = class idex extends Exchange { * @name idex#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the idex api endpoint @@ -1394,7 +1394,7 @@ module.exports = class idex extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 idex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ this.checkRequiredCredentials (); await this.loadMarkets (); @@ -1509,7 +1509,7 @@ module.exports = class idex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the idex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ params = this.extend ({ 'method': 'privateGetDeposits', @@ -1562,7 +1562,7 @@ module.exports = class idex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the idex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ params = this.extend ({ 'method': 'privateGetWithdrawals', diff --git a/js/independentreserve.js b/js/independentreserve.js index cdcf7ce5eb1f..ae8c8a479696 100644 --- a/js/independentreserve.js +++ b/js/independentreserve.js @@ -138,7 +138,7 @@ module.exports = class independentreserve extends Exchange { * @name independentreserve#fetchMarkets * @description retrieves data on all markets for independentreserve * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const baseCurrencies = await this.publicGetGetValidPrimaryCurrencyCodes (params); // ['Xbt', 'Eth', 'Usdt', ...] @@ -492,7 +492,7 @@ module.exports = class independentreserve extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the independentreserve api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = this.ordered ({}); @@ -521,7 +521,7 @@ module.exports = class independentreserve extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the independentreserve api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = this.ordered ({}); @@ -550,7 +550,7 @@ module.exports = class independentreserve extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the independentreserve api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const pageIndex = this.safeInteger (params, 'pageIndex', 1); @@ -619,7 +619,7 @@ module.exports = class independentreserve extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the independentreserve api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -687,8 +687,8 @@ module.exports = class independentreserve extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 independentreserve api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ diff --git a/js/indodax.js b/js/indodax.js index 85f331aaebb0..fcdfc281da5d 100644 --- a/js/indodax.js +++ b/js/indodax.js @@ -194,7 +194,7 @@ module.exports = class indodax extends Exchange { * @name indodax#fetchMarkets * @description retrieves data on all markets for indodax * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetPairs (params); // @@ -474,7 +474,7 @@ module.exports = class indodax extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the indodax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -605,7 +605,7 @@ module.exports = class indodax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the indodax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -646,7 +646,7 @@ module.exports = class indodax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the indodax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchClosedOrders() requires a symbol argument'); @@ -673,8 +673,8 @@ module.exports = class indodax extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 indodax api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -872,7 +872,7 @@ module.exports = class indodax extends Exchange { * @name indodax#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the indodax api endpoint diff --git a/js/itbit.js b/js/itbit.js index 883a090c04b8..bff7591bfdae 100644 --- a/js/itbit.js +++ b/js/itbit.js @@ -451,7 +451,7 @@ module.exports = class itbit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the itbit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const walletId = this.safeString (params, 'walletId'); @@ -511,7 +511,7 @@ module.exports = class itbit extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the itbit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -592,7 +592,7 @@ module.exports = class itbit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the itbit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'open', @@ -609,7 +609,7 @@ module.exports = class itbit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the itbit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'filled', @@ -626,7 +626,7 @@ module.exports = class itbit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the itbit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -729,8 +729,8 @@ module.exports = class itbit extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 itbit api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ diff --git a/js/kraken.js b/js/kraken.js index 3a0740f3e825..35ebe425f234 100644 --- a/js/kraken.js +++ b/js/kraken.js @@ -342,7 +342,7 @@ module.exports = class kraken extends Exchange { * @name kraken#fetchMarkets * @description retrieves data on all markets for kraken * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetAssetPairs (params); // @@ -1139,7 +1139,7 @@ module.exports = class kraken extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the kraken api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1236,8 +1236,8 @@ module.exports = class kraken extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 kraken api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1579,7 +1579,7 @@ module.exports = class kraken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the kraken api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const orderTrades = this.safeValue (params, 'trades'); const tradeIds = []; @@ -1674,7 +1674,7 @@ module.exports = class kraken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the kraken api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1787,7 +1787,7 @@ module.exports = class kraken extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 kraken api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); return await this.privatePostCancelAll (params); @@ -1802,7 +1802,7 @@ module.exports = class kraken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the kraken api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1834,7 +1834,7 @@ module.exports = class kraken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the kraken api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -2035,7 +2035,7 @@ module.exports = class kraken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the kraken api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ // https://www.kraken.com/en-us/help/api#deposit-status if (code === undefined) { @@ -2095,7 +2095,7 @@ module.exports = class kraken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the kraken api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ // https://www.kraken.com/en-us/help/api#withdraw-status if (code === undefined) { @@ -2260,7 +2260,7 @@ module.exports = class kraken extends Exchange { * @name kraken#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the kraken api endpoint @@ -2298,7 +2298,7 @@ module.exports = class kraken extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols not used by kraken fetchPositions () * @param {object} params extra parameters specific to the kraken api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const request = { diff --git a/js/kucoin.js b/js/kucoin.js index b91c29911834..f898699a0abc 100644 --- a/js/kucoin.js +++ b/js/kucoin.js @@ -506,7 +506,7 @@ module.exports = class kucoin extends Exchange { * @name kucoin#fetchMarkets * @description retrieves data on all markets for kucoin * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetSymbols (params); // @@ -1202,15 +1202,15 @@ module.exports = class kucoin extends Exchange { * @param {string} symbol Unified CCXT market symbol * @param {string} type 'limit' or 'market' * @param {string} side 'buy' or 'sell' - * @param {float} amount the amount of currency to trade - * @param {float} price *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency + * @param {number} amount the amount of currency to trade + * @param {number} price *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency * @param {object} params Extra parameters specific to the exchange API endpoint * @param {string} params.clientOid client order id, defaults to uuid if not passed * @param {string} params.remark remark for the order, length cannot exceed 100 utf8 characters * @param {string} params.tradeType 'TRADE', // TRADE, MARGIN_TRADE // not used with margin orders * limit orders --------------------------------------------------- * @param {string} params.timeInForce GTC, GTT, IOC, or FOK, default is GTC, limit orders only - * @param {float} params.cancelAfter long, // cancel after n seconds, requires timeInForce to be GTT + * @param {number} params.cancelAfter long, // cancel after n seconds, requires timeInForce to be GTT * @param {string} params.postOnly Post only flag, invalid when timeInForce is IOC or FOK * @param {bool} params.hidden false, // Order will not be displayed in the order book * @param {bool} params.iceberg false, // Only a portion of the order is displayed in the order book @@ -1219,9 +1219,9 @@ module.exports = class kucoin extends Exchange { * @param {string} params.funds // Amount of quote currency to use * stop orders ---------------------------------------------------- * @param {string} params.stop Either loss or entry, the default is loss. Requires stopPrice to be defined - * @param {float} params.stopPrice The price at which a trigger order is triggered at + * @param {number} params.stopPrice The price at which a trigger order is triggered at * margin orders -------------------------------------------------- - * @param {float} params.leverage Leverage size of the order + * @param {number} params.leverage Leverage size of the order * @param {string} params.stp '', // self trade prevention, CN, CO, CB or DC * @param {string} params.marginMode 'cross', // cross (cross mode) and isolated (isolated mode), set to cross by default, the isolated mode will be released soon, stay tuned * @param {bool} params.autoBorrow false, // The system will first borrow you funds at the optimal interest rate and then place an order for you @@ -1482,7 +1482,7 @@ module.exports = class kucoin extends Exchange { * @param {string|undefined} params.side buy or sell * @param {string|undefined} params.type limit, market, limit_stop or market_stop * @param {string|undefined} params.tradeType TRADE for spot trading, MARGIN_TRADE for Margin Trading - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStatus ('done', symbol, since, limit, params); } @@ -1503,7 +1503,7 @@ module.exports = class kucoin extends Exchange { * @param {string} params.tradeType TRADE for spot trading, MARGIN_TRADE for Margin Trading * @param {number} params.currentPage *stop orders only* current page * @param {string} params.orderIds *stop orders only* comma seperated order ID list - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStatus ('active', symbol, since, limit, params); } @@ -1664,7 +1664,7 @@ module.exports = class kucoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the kucoin api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const request = { 'orderId': id, @@ -1681,7 +1681,7 @@ module.exports = class kucoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the kucoin api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = {}; @@ -1776,7 +1776,7 @@ module.exports = class kucoin extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the kucoin api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1986,7 +1986,7 @@ module.exports = class kucoin extends Exchange { * @name kucoin#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the kucoin api endpoint @@ -2161,7 +2161,7 @@ module.exports = class kucoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the kucoin api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; @@ -2235,7 +2235,7 @@ module.exports = class kucoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the kucoin api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; @@ -2357,7 +2357,7 @@ module.exports = class kucoin extends Exchange { * @name kucoin#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the kucoin api endpoint diff --git a/js/kucoinfutures.js b/js/kucoinfutures.js index 375d20229a68..1d5b6bff1e1a 100644 --- a/js/kucoinfutures.js +++ b/js/kucoinfutures.js @@ -351,7 +351,7 @@ module.exports = class kucoinfutures extends kucoin { * @name kucoinfutures#fetchMarkets * @description retrieves data on all markets for kucoinfutures * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.futuresPublicGetContractsActive (params); // @@ -862,7 +862,7 @@ module.exports = class kucoinfutures extends kucoin { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the kucoinfutures api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const response = await this.futuresPrivateGetPositions (params); @@ -1015,11 +1015,11 @@ module.exports = class kucoinfutures extends kucoin { * @param {string} symbol Unified CCXT market symbol * @param {string} type 'limit' or 'market' * @param {string} side 'buy' or 'sell' - * @param {float} amount the amount of currency to trade - * @param {float} price *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency + * @param {number} amount the amount of currency to trade + * @param {number} price *ignored in "market" orders* the price at which the order is to be fullfilled at in units of the quote currency * @param {object} params Extra parameters specific to the exchange API endpoint - * @param {float} params.leverage Leverage size of the order - * @param {float} params.stopPrice The price at which a trigger order is triggered at + * @param {number} params.leverage Leverage size of the order + * @param {number} params.stopPrice The price at which a trigger order is triggered at * @param {bool} params.reduceOnly A mark to reduce the position size only. Set to false by default. Need to set the position size when reduceOnly is true. * @param {string} params.timeInForce GTC, GTT, IOC, or FOK, default is GTC, limit orders only * @param {string} params.postOnly Post only flag, invalid when timeInForce is IOC or FOK @@ -1180,7 +1180,7 @@ module.exports = class kucoinfutures extends kucoin { * @name kucoinfutures#addMargin * @description add margin * @param {string} symbol unified market symbol - * @param {float} amount amount of margin to add + * @param {number} amount amount of margin to add * @param {object} params extra parameters specific to the kucoinfutures api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#add-margin-structure} */ @@ -1373,7 +1373,7 @@ module.exports = class kucoinfutures extends kucoin { * @param {number|undefined} params.till end time in ms * @param {string|undefined} params.side buy or sell * @param {string|undefined} params.type limit, or market - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByStatus ('done', symbol, since, limit, params); } @@ -1585,7 +1585,7 @@ module.exports = class kucoinfutures extends kucoin { * @name kucoinfutures#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the kucoinfutures api endpoint @@ -1657,7 +1657,7 @@ module.exports = class kucoinfutures extends kucoin { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the kucoinfutures api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1724,7 +1724,7 @@ module.exports = class kucoinfutures extends kucoin { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the kucoinfutures api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1881,7 +1881,7 @@ module.exports = class kucoinfutures extends kucoin { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the kucoinfutures api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; @@ -1937,7 +1937,7 @@ module.exports = class kucoinfutures extends kucoin { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the kucoinfutures api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; diff --git a/js/latoken.js b/js/latoken.js index 9891036ad56b..029cef3dba75 100644 --- a/js/latoken.js +++ b/js/latoken.js @@ -232,7 +232,7 @@ module.exports = class latoken extends Exchange { * @name latoken#fetchMarkets * @description retrieves data on all markets for latoken * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const currencies = await this.fetchCurrenciesFromCache (params); // @@ -760,7 +760,7 @@ module.exports = class latoken extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the latoken api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -859,7 +859,7 @@ module.exports = class latoken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the latoken api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1041,7 +1041,7 @@ module.exports = class latoken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the latoken api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -1087,7 +1087,7 @@ module.exports = class latoken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the latoken api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1178,8 +1178,8 @@ module.exports = class latoken extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 latoken api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1251,7 +1251,7 @@ module.exports = class latoken extends Exchange { * @description cancel all open orders in a market * @param {string} symbol unified market symbol of the market to cancel orders in * @param {object} params extra parameters specific to the latoken api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1412,7 +1412,7 @@ module.exports = class latoken extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch transfers for * @param {number|undefined} limit the maximum number of transfers structures to retrieve * @param {object} params extra parameters specific to the latoken api endpoint - * @returns {[dict]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} + * @returns {[object]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} */ await this.loadMarkets (); const currency = this.currency (code); @@ -1458,7 +1458,7 @@ module.exports = class latoken extends Exchange { * @name latoken#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the latoken api endpoint diff --git a/js/lbank.js b/js/lbank.js index 2a2dc23c6568..05ffc2890e94 100644 --- a/js/lbank.js +++ b/js/lbank.js @@ -143,7 +143,7 @@ module.exports = class lbank extends Exchange { * @name lbank#fetchMarkets * @description retrieves data on all markets for lbank * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetAccuracy (params); // @@ -389,7 +389,7 @@ module.exports = class lbank extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the lbank api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -594,8 +594,8 @@ module.exports = class lbank extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 lbank api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -677,7 +677,7 @@ module.exports = class lbank extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the lbank api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); if (limit === undefined) { @@ -703,7 +703,7 @@ module.exports = class lbank extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the lbank api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); if (symbol !== undefined) { @@ -723,7 +723,7 @@ module.exports = class lbank extends Exchange { * @name lbank#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the lbank api endpoint diff --git a/js/lbank2.js b/js/lbank2.js index f10baf1e8e6a..e9a17386a4bd 100644 --- a/js/lbank2.js +++ b/js/lbank2.js @@ -266,7 +266,7 @@ module.exports = class lbank2 extends Exchange { * @name lbank2#fetchMarkets * @description retrieves data on all markets for lbank2 * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ // needs to return a list of unified market structures const response = await this.publicGetAccuracy (); @@ -594,7 +594,7 @@ module.exports = class lbank2 extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the lbank2 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -919,8 +919,8 @@ module.exports = class lbank2 extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 lbank2 api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1244,7 +1244,7 @@ module.exports = class lbank2 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the lbank2 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades () requires a symbol argument'); @@ -1302,7 +1302,7 @@ module.exports = class lbank2 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the lbank2 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ // default query is for canceled and completely filled orders // does not return open orders unless specified explicitly @@ -1362,7 +1362,7 @@ module.exports = class lbank2 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the lbank2 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -1459,7 +1459,7 @@ module.exports = class lbank2 extends Exchange { * @description cancel all open orders in a market * @param {string} symbol unified market symbol of the market to cancel orders in * @param {object} params extra parameters specific to the lbank2 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' cancelAllOrders() requires a symbol argument'); @@ -1599,7 +1599,7 @@ module.exports = class lbank2 extends Exchange { * @name lbank2#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the lbank2 api endpoint @@ -1769,7 +1769,7 @@ module.exports = class lbank2 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the lbank2 api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1821,7 +1821,7 @@ module.exports = class lbank2 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the lbank2 api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { diff --git a/js/liquid.js b/js/liquid.js index d5eb604959b6..a08676f9277e 100644 --- a/js/liquid.js +++ b/js/liquid.js @@ -320,7 +320,7 @@ module.exports = class liquid extends Exchange { * @name liquid#fetchMarkets * @description retrieves data on all markets for liquid * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const spot = await this.publicGetProducts (params); // @@ -741,7 +741,7 @@ module.exports = class liquid extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the liquid api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -944,7 +944,7 @@ module.exports = class liquid extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the liquid api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const market = this.market (symbol); @@ -968,8 +968,8 @@ module.exports = class liquid extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 liquid api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1239,7 +1239,7 @@ module.exports = class liquid extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the liquid api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1325,7 +1325,7 @@ module.exports = class liquid extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the liquid api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'live' }; return await this.fetchOrders (symbol, since, limit, this.extend (request, params)); @@ -1340,7 +1340,7 @@ module.exports = class liquid extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the liquid api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'filled' }; return await this.fetchOrders (symbol, since, limit, this.extend (request, params)); @@ -1352,7 +1352,7 @@ module.exports = class liquid extends Exchange { * @name liquid#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the liquid api endpoint @@ -1421,7 +1421,7 @@ module.exports = class liquid extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the liquid api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { diff --git a/js/luno.js b/js/luno.js index 2cc0ac513694..2b4293ca5a69 100644 --- a/js/luno.js +++ b/js/luno.js @@ -156,7 +156,7 @@ module.exports = class luno extends Exchange { * @name luno#fetchMarkets * @description retrieves data on all markets for luno * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.exchangeGetMarkets (params); // @@ -468,7 +468,7 @@ module.exports = class luno extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the luno api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByState (undefined, symbol, since, limit, params); } @@ -482,7 +482,7 @@ module.exports = class luno extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the luno api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByState ('PENDING', symbol, since, limit, params); } @@ -496,7 +496,7 @@ module.exports = class luno extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the luno api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByState ('COMPLETE', symbol, since, limit, params); } @@ -690,7 +690,7 @@ module.exports = class luno extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the luno api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -727,7 +727,7 @@ module.exports = class luno extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the luno api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires a symbol argument'); @@ -794,8 +794,8 @@ module.exports = class luno extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 luno api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ diff --git a/js/lykke.js b/js/lykke.js index 6b2c9026c6c8..bb3da06adebb 100644 --- a/js/lykke.js +++ b/js/lykke.js @@ -259,7 +259,7 @@ module.exports = class lykke extends Exchange { * @name lykke#fetchMarkets * @description retrieves data on all markets for lykke * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetAssetpairs (params); const markets = this.safeValue (response, 'payload', []); @@ -618,7 +618,7 @@ module.exports = class lykke extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the lykke api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -780,8 +780,8 @@ module.exports = class lykke extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 lykke api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -873,7 +873,7 @@ module.exports = class lykke extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 lykke api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -939,7 +939,7 @@ module.exports = class lykke extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the lykke api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -988,7 +988,7 @@ module.exports = class lykke extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the lykke api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -1037,7 +1037,7 @@ module.exports = class lykke extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the lykke api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1234,7 +1234,7 @@ module.exports = class lykke extends Exchange { * @name lykke#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the lykke api endpoint diff --git a/js/mercado.js b/js/mercado.js index ff51f4e97913..ecd00c2be14b 100644 --- a/js/mercado.js +++ b/js/mercado.js @@ -154,7 +154,7 @@ module.exports = class mercado extends Exchange { * @name mercado#fetchMarkets * @description retrieves data on all markets for mercado * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetCoins (params); // @@ -374,7 +374,7 @@ module.exports = class mercado extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the mercado api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -434,8 +434,8 @@ module.exports = class mercado extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 mercado api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -627,7 +627,7 @@ module.exports = class mercado extends Exchange { * @name mercado#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the mercado api endpoint @@ -778,7 +778,7 @@ module.exports = class mercado extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the mercado api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -803,7 +803,7 @@ module.exports = class mercado extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the mercado api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -829,7 +829,7 @@ module.exports = class mercado extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the mercado api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires a symbol argument'); diff --git a/js/mexc.js b/js/mexc.js index e57c9184e0fc..9d8968f98299 100644 --- a/js/mexc.js +++ b/js/mexc.js @@ -527,7 +527,7 @@ module.exports = class mexc extends Exchange { * @name mexc#fetchMarkets * @description retrieves data on all markets for mexc * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const defaultType = this.safeString2 (this.options, 'fetchMarkets', 'defaultType', 'spot'); const type = this.safeString (params, 'type', defaultType); @@ -1052,7 +1052,7 @@ module.exports = class mexc extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1549,7 +1549,7 @@ module.exports = class mexc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1611,7 +1611,7 @@ module.exports = class mexc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1779,7 +1779,7 @@ module.exports = class mexc extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const response = await this.contractPrivateGetPositionOpenPositions (params); @@ -1887,8 +1887,8 @@ module.exports = class mexc extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 mexc api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -2374,7 +2374,7 @@ module.exports = class mexc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -2650,7 +2650,7 @@ module.exports = class mexc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchClosedOrders() requires a symbol argument'); @@ -2672,7 +2672,7 @@ module.exports = class mexc extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 mexc api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const market = this.market (symbol); @@ -2730,7 +2730,7 @@ module.exports = class mexc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires a symbol argument'); @@ -2783,7 +2783,7 @@ module.exports = class mexc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -2864,7 +2864,7 @@ module.exports = class mexc extends Exchange { * @name mexc#reduceMargin * @description remove margin from a position * @param {string} symbol unified market symbol - * @param {float} amount the amount of margin to remove + * @param {number} amount the amount of margin to remove * @param {object} params extra parameters specific to the mexc api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#reduce-margin-structure} */ @@ -2877,7 +2877,7 @@ module.exports = class mexc extends Exchange { * @name mexc#addMargin * @description add margin * @param {string} symbol unified market symbol - * @param {float} amount amount of margin to add + * @param {number} amount amount of margin to add * @param {object} params extra parameters specific to the mexc api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#add-margin-structure} */ @@ -2889,7 +2889,7 @@ module.exports = class mexc extends Exchange { * @method * @name mexc#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string|undefined} symbol unified market symbol * @param {object} params extra parameters specific to the mexc api endpoint * @returns {object} response from the exchange @@ -2947,7 +2947,7 @@ module.exports = class mexc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch transfers for * @param {number|undefined} limit the maximum number of transfers structures to retrieve * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} + * @returns {[object]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} */ await this.loadMarkets (); const request = {}; @@ -2996,7 +2996,7 @@ module.exports = class mexc extends Exchange { * @name mexc#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the mexc api endpoint @@ -3071,7 +3071,7 @@ module.exports = class mexc extends Exchange { * @name mexc#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the mexc api endpoint @@ -3332,7 +3332,7 @@ module.exports = class mexc extends Exchange { * @param {number|undefined} since not used by mexc, but filtered internally by ccxt * @param {number|undefined} limit mexc limit is page_size default 20, maximum is 100 * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} + * @returns {[object]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchFundingRateHistory() requires a symbol argument'); diff --git a/js/mexc3.js b/js/mexc3.js index af786ce61e38..bc9634a0a6ae 100644 --- a/js/mexc3.js +++ b/js/mexc3.js @@ -625,7 +625,7 @@ module.exports = class mexc3 extends Exchange { * @name mexc3#fetchMarkets * @description retrieves data on all markets for mexc3 * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const spotMarket = await this.fetchSpotMarkets (params); const swapMarket = await this.fetchSwapMarkets (params); @@ -928,7 +928,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1586,8 +1586,8 @@ module.exports = class mexc3 extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 mexc3 api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1846,7 +1846,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -2042,7 +2042,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -2099,7 +2099,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByState (3, symbol, since, limit, params); } @@ -2249,7 +2249,7 @@ module.exports = class mexc3 extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 mexc3 api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const market = symbol !== undefined ? this.market (symbol) : undefined; @@ -2649,7 +2649,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires a symbol argument'); @@ -2740,7 +2740,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = {}; @@ -2835,7 +2835,7 @@ module.exports = class mexc3 extends Exchange { * @name mexc3#reduceMargin * @description remove margin from a position * @param {string} symbol unified market symbol - * @param {float} amount the amount of margin to remove + * @param {number} amount the amount of margin to remove * @param {object} params extra parameters specific to the mexc3 api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#reduce-margin-structure} */ @@ -2848,7 +2848,7 @@ module.exports = class mexc3 extends Exchange { * @name mexc3#addMargin * @description add margin * @param {string} symbol unified market symbol - * @param {float} amount amount of margin to add + * @param {number} amount amount of margin to add * @param {object} params extra parameters specific to the mexc3 api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#add-margin-structure} */ @@ -2860,7 +2860,7 @@ module.exports = class mexc3 extends Exchange { * @method * @name mexc3#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string|undefined} symbol unified market symbol * @param {object} params extra parameters specific to the mexc3 api endpoint * @returns {object} response from the exchange @@ -3047,7 +3047,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since not used by mexc, but filtered internally by ccxt * @param {number|undefined} limit mexc limit is page_size default 20, maximum is 100 * @param {object} params extra parameters specific to the mexc api endpoint - * @returns {[dict]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} + * @returns {[object]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchFundingRateHistory() requires a symbol argument'); @@ -3349,7 +3349,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -3418,7 +3418,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -3591,7 +3591,7 @@ module.exports = class mexc3 extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const response = await this.contractPrivateGetPositionOpenPositions (params); @@ -3728,7 +3728,7 @@ module.exports = class mexc3 extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch transfers for * @param {number|undefined} limit the maximum number of transfers structures to retrieve * @param {object} params extra parameters specific to the mexc3 api endpoint - * @returns {[dict]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} + * @returns {[object]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} */ const [ marketType, query ] = this.handleMarketTypeAndParams ('fetchTransfers', undefined, params); await this.loadMarkets (); @@ -3812,7 +3812,7 @@ module.exports = class mexc3 extends Exchange { * @name mexc3#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the mexc3 api endpoint @@ -3934,7 +3934,7 @@ module.exports = class mexc3 extends Exchange { * @name mexc3#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the mexc3 api endpoint diff --git a/js/ndax.js b/js/ndax.js index 7658880a5362..afefd11fcc7b 100644 --- a/js/ndax.js +++ b/js/ndax.js @@ -381,7 +381,7 @@ module.exports = class ndax extends Exchange { * @name ndax#fetchMarkets * @description retrieves data on all markets for ndax * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const omsId = this.safeInteger (this.options, 'omsId', 1); const request = { @@ -944,7 +944,7 @@ module.exports = class ndax extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the ndax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} */ const omsId = this.safeInteger (this.options, 'omsId', 1); await this.loadMarkets (); @@ -1322,8 +1322,8 @@ module.exports = class ndax extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 ndax api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1429,7 +1429,7 @@ module.exports = class ndax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the ndax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const omsId = this.safeInteger (this.options, 'omsId', 1); await this.loadMarkets (); @@ -1515,7 +1515,7 @@ module.exports = class ndax extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 ndax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const omsId = this.safeInteger (this.options, 'omsId', 1); await this.loadMarkets (); @@ -1591,7 +1591,7 @@ module.exports = class ndax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the ndax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const omsId = this.safeInteger (this.options, 'omsId', 1); await this.loadMarkets (); @@ -1670,7 +1670,7 @@ module.exports = class ndax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the ndax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const omsId = this.safeInteger (this.options, 'omsId', 1); await this.loadMarkets (); @@ -1842,7 +1842,7 @@ module.exports = class ndax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the ndax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const omsId = this.safeInteger (this.options, 'omsId', 1); await this.loadMarkets (); @@ -2013,7 +2013,7 @@ module.exports = class ndax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the ndax api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const omsId = this.safeInteger (this.options, 'omsId', 1); await this.loadMarkets (); @@ -2063,7 +2063,7 @@ module.exports = class ndax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the ndax api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const omsId = this.safeInteger (this.options, 'omsId', 1); await this.loadMarkets (); @@ -2259,7 +2259,7 @@ module.exports = class ndax extends Exchange { * @name ndax#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the ndax api endpoint diff --git a/js/novadax.js b/js/novadax.js index 1dcc5b0065ba..898c968c0a56 100644 --- a/js/novadax.js +++ b/js/novadax.js @@ -214,7 +214,7 @@ module.exports = class novadax extends Exchange { * @name novadax#fetchMarkets * @description retrieves data on all markets for novadax * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetCommonSymbols (params); // @@ -556,7 +556,7 @@ module.exports = class novadax extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the novadax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -718,8 +718,8 @@ module.exports = class novadax extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 novadax api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -880,7 +880,7 @@ module.exports = class novadax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the novadax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -940,7 +940,7 @@ module.exports = class novadax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the novadax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'SUBMITTED,PROCESSING,PARTIAL_FILLED,CANCELING', @@ -957,7 +957,7 @@ module.exports = class novadax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the novadax api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'FILLED,CANCELED,REJECTED', @@ -975,7 +975,7 @@ module.exports = class novadax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the novadax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1104,7 +1104,7 @@ module.exports = class novadax extends Exchange { * @name novadax#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the novadax api endpoint @@ -1179,7 +1179,7 @@ module.exports = class novadax extends Exchange { * @name novadax#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the novadax api endpoint @@ -1255,7 +1255,7 @@ module.exports = class novadax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the novadax api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'type': 'coin_in', @@ -1272,7 +1272,7 @@ module.exports = class novadax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the novadax api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'type': 'coin_out', @@ -1423,7 +1423,7 @@ module.exports = class novadax extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the novadax api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { diff --git a/js/oceanex.js b/js/oceanex.js index 918aa771e7df..cff33c0de0df 100644 --- a/js/oceanex.js +++ b/js/oceanex.js @@ -147,7 +147,7 @@ module.exports = class oceanex extends Exchange { * @name oceanex#fetchMarkets * @description retrieves data on all markets for oceanex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const request = { 'show_details': true }; const response = await this.publicGetMarkets (this.extend (request, params)); @@ -459,7 +459,7 @@ module.exports = class oceanex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the oceanex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -623,8 +623,8 @@ module.exports = class oceanex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 oceanex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -687,7 +687,7 @@ module.exports = class oceanex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the oceanex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'states': [ 'wait' ], @@ -704,7 +704,7 @@ module.exports = class oceanex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the oceanex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'states': [ 'done', 'cancel' ], @@ -721,7 +721,7 @@ module.exports = class oceanex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the oceanex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a `symbol` argument'); @@ -914,7 +914,7 @@ module.exports = class oceanex extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 oceanex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const response = await this.privatePostOrdersClear (params); diff --git a/js/okcoin.js b/js/okcoin.js index 7ca4700937c0..931ecc54c0d5 100644 --- a/js/okcoin.js +++ b/js/okcoin.js @@ -805,7 +805,7 @@ module.exports = class okcoin extends Exchange { * @name okcoin#fetchMarkets * @description retrieves data on all markets for okcoin * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const types = this.safeValue (this.options, 'fetchMarkets'); let result = []; @@ -1461,7 +1461,7 @@ module.exports = class okcoin extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the okcoin api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -2091,8 +2091,8 @@ module.exports = class okcoin extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 okcoin api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -2621,7 +2621,7 @@ module.exports = class okcoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the okcoin api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ // '-2': failed, // '-1': cancelled, @@ -2644,7 +2644,7 @@ module.exports = class okcoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the okcoin api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ // '-2': failed, // '-1': cancelled, @@ -2721,7 +2721,7 @@ module.exports = class okcoin extends Exchange { * @name okcoin#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the okcoin api endpoint @@ -2819,7 +2819,7 @@ module.exports = class okcoin extends Exchange { * @name okcoin#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the okcoin api endpoint @@ -2875,7 +2875,7 @@ module.exports = class okcoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the okcoin api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; @@ -2899,7 +2899,7 @@ module.exports = class okcoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the okcoin api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = {}; @@ -3210,7 +3210,7 @@ module.exports = class okcoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the okcoin api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ // okex actually returns ledger entries instead of fills here, so each fill in the order // is represented by two trades with opposite buy/sell sides, not one :\ @@ -3319,7 +3319,7 @@ module.exports = class okcoin extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the okcoin api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const request = { // 'instrument_id': market['id'], @@ -3548,7 +3548,7 @@ module.exports = class okcoin extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols not used by okcoin fetchPositions * @param {object} params extra parameters specific to the okcoin api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); let method = undefined; diff --git a/js/okx.js b/js/okx.js index 9bdeec54110d..3b065a2855e3 100644 --- a/js/okx.js +++ b/js/okx.js @@ -850,7 +850,7 @@ module.exports = class okx extends Exchange { * @name okx#fetchMarkets * @description retrieves data on all markets for okx * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const types = this.safeValue (this.options, 'fetchMarkets'); let promises = []; @@ -1528,7 +1528,7 @@ module.exports = class okx extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the okx api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1656,7 +1656,7 @@ module.exports = class okx extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest funding rate to fetch * @param {number|undefined} limit the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} to fetch * @param {object} params extra parameters specific to the okx api endpoint - * @returns {[dict]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} + * @returns {[object]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchFundingRateHistory() requires a symbol argument'); @@ -1968,8 +1968,8 @@ module.exports = class okx extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 okx api endpoint * @param {bool|undefined} params.reduceOnly MARGIN orders only, or swap/future orders in net mode * @param {bool|undefined} params.postOnly true to place a post only order @@ -2648,7 +2648,7 @@ module.exports = class okx extends Exchange { * @param {bool} params.stop True if fetching trigger orders * @param {string} params.ordType "conditional", "oco", "trigger", "move_order_stop", "iceberg", or "twap" * @param {string} params.algoId Algo ID - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -2940,7 +2940,7 @@ module.exports = class okx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the okx api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -3021,7 +3021,7 @@ module.exports = class okx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the okx api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -3083,7 +3083,7 @@ module.exports = class okx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the okx api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ const request = { // 'instrument_id': market['id'], @@ -3519,7 +3519,7 @@ module.exports = class okx extends Exchange { * @name okx#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the okx api endpoint @@ -3588,7 +3588,7 @@ module.exports = class okx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the okx api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -3688,7 +3688,7 @@ module.exports = class okx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the okx api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -4043,7 +4043,7 @@ module.exports = class okx extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the okx api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); // const defaultType = this.safeString2 (this.options, 'fetchPositions', 'defaultType'); @@ -4247,7 +4247,7 @@ module.exports = class okx extends Exchange { * @name okx#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the okx api endpoint @@ -4667,7 +4667,7 @@ module.exports = class okx extends Exchange { * @method * @name okx#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the okx api endpoint * @returns {object} response from the exchange @@ -4982,7 +4982,7 @@ module.exports = class okx extends Exchange { * @param {number|undefined} since timestamp for the earliest borrow rate * @param {number|undefined} limit the maximum number of [borrow rate structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-rate-structure} to retrieve * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of [borrow rate structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-rate-structure} + * @returns {[object]} an array of [borrow rate structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-rate-structure} */ await this.loadMarkets (); const currency = this.currency (code); @@ -5073,7 +5073,7 @@ module.exports = class okx extends Exchange { * @name okx#reduceMargin * @description remove margin from a position * @param {string} symbol unified market symbol - * @param {float} amount the amount of margin to remove + * @param {number} amount the amount of margin to remove * @param {object} params extra parameters specific to the okx api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#reduce-margin-structure} */ @@ -5086,7 +5086,7 @@ module.exports = class okx extends Exchange { * @name okx#addMargin * @description add margin * @param {string} symbol unified market symbol - * @param {float} amount amount of margin to add + * @param {number} amount amount of margin to add * @param {object} params extra parameters specific to the okx api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#add-margin-structure} */ @@ -5201,7 +5201,7 @@ module.exports = class okx extends Exchange { * @param {number|undefined} limit the number of [borrow interest structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-interest-structure} to retrieve * @param {object} params exchange specific parameters * @param {number|undefined} params.type Loan type 1 - VIP loans 2 - Market loans *Default is Market loans* - * @returns {[dict]} An list of [borrow interest structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-interest-structure} + * @returns {[object]} An list of [borrow interest structures]{@link https://docs.ccxt.com/en/latest/manual.html#borrow-interest-structure} */ await this.loadMarkets (); const request = { @@ -5277,7 +5277,7 @@ module.exports = class okx extends Exchange { * @description create a loan to borrow margin * @see https://www.okx.com/docs-v5/en/#rest-api-account-vip-loans-borrow-and-repay * @param {string} code unified currency code of the currency to borrow - * @param {float} amount the amount to borrow + * @param {number} amount the amount to borrow * @param {string|undefined} symbol not used by okx.borrowMargin () * @param {object} params extra parameters specific to the okx api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} @@ -5322,7 +5322,7 @@ module.exports = class okx extends Exchange { * @description repay borrowed margin and interest * @see https://www.okx.com/docs-v5/en/#rest-api-account-vip-loans-borrow-and-repay * @param {string} code unified currency code of the currency to repay - * @param {float} amount the amount to repay + * @param {number} amount the amount to repay * @param {string|undefined} symbol not used by okx.repayMargin () * @param {object} params extra parameters specific to the okx api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} diff --git a/js/phemex.js b/js/phemex.js index ec0b11acc1f2..441971f37b44 100644 --- a/js/phemex.js +++ b/js/phemex.js @@ -651,7 +651,7 @@ module.exports = class phemex extends Exchange { * @name phemex#fetchMarkets * @description retrieves data on all markets for phemex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const v2Products = await this.publicGetCfgV2Products (params); // @@ -1238,7 +1238,7 @@ module.exports = class phemex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1936,8 +1936,8 @@ module.exports = class phemex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 phemex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -2202,7 +2202,7 @@ module.exports = class phemex extends Exchange { * @description cancel all open orders in a market * @param {string} symbol unified market symbol of the market to cancel orders in * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' cancelAllOrders() requires a symbol argument'); @@ -2273,7 +2273,7 @@ module.exports = class phemex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -2305,7 +2305,7 @@ module.exports = class phemex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -2342,7 +2342,7 @@ module.exports = class phemex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchClosedOrders() requires a symbol argument'); @@ -2414,7 +2414,7 @@ module.exports = class phemex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires a symbol argument'); @@ -2568,7 +2568,7 @@ module.exports = class phemex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); let currency = undefined; @@ -2609,7 +2609,7 @@ module.exports = class phemex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); let currency = undefined; @@ -2734,7 +2734,7 @@ module.exports = class phemex extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const defaultSubType = this.safeString (this.options, 'defaultSubType', 'linear'); @@ -3135,7 +3135,7 @@ module.exports = class phemex extends Exchange { * @description Either adds or reduces margin in an isolated position in order to set the margin to a specific value * @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#assign-position-balance-in-isolated-marign-mode * @param {string} symbol unified market symbol of the market to set margin in - * @param {float} amount the amount to set the margin to + * @param {number} amount the amount to set the margin to * @param {object} params parameters specific to the phemex api endpoint * @returns {object} A [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#add-margin-structure} */ @@ -3393,7 +3393,7 @@ module.exports = class phemex extends Exchange { * @method * @name phemex#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the phemex api endpoint * @returns {object} response from the exchange @@ -3421,7 +3421,7 @@ module.exports = class phemex extends Exchange { * @name phemex#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the phemex api endpoint @@ -3509,7 +3509,7 @@ module.exports = class phemex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch transfers for * @param {number|undefined} limit the maximum number of transfers structures to retrieve * @param {object} params extra parameters specific to the phemex api endpoint - * @returns {[dict]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} + * @returns {[object]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} */ await this.loadMarkets (); if (code === undefined) { diff --git a/js/probit.js b/js/probit.js index 4c3eecd23408..d8c63c2989d7 100644 --- a/js/probit.js +++ b/js/probit.js @@ -238,7 +238,7 @@ module.exports = class probit extends Exchange { * @name probit#fetchMarkets * @description retrieves data on all markets for probit * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetMarket (params); // @@ -660,7 +660,7 @@ module.exports = class probit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the probit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -712,7 +712,7 @@ module.exports = class probit extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the probit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -976,7 +976,7 @@ module.exports = class probit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the probit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); since = this.parse8601 (since); @@ -1000,7 +1000,7 @@ module.exports = class probit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the probit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1140,8 +1140,8 @@ module.exports = class probit extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 probit api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1346,7 +1346,7 @@ module.exports = class probit extends Exchange { * @name probit#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the probit api endpoint diff --git a/js/qtrade.js b/js/qtrade.js index 80f6d7fa808d..5c9dbd6feae7 100644 --- a/js/qtrade.js +++ b/js/qtrade.js @@ -172,7 +172,7 @@ module.exports = class qtrade extends Exchange { * @name qtrade#fetchMarkets * @description retrieves data on all markets for qtrade * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetMarkets (params); // @@ -626,7 +626,7 @@ module.exports = class qtrade extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the qtrade api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -668,7 +668,7 @@ module.exports = class qtrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the qtrade api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -909,8 +909,8 @@ module.exports = class qtrade extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 qtrade api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1153,7 +1153,7 @@ module.exports = class qtrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the qtrade api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = { @@ -1214,7 +1214,7 @@ module.exports = class qtrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the qtrade api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'open': true }; return await this.fetchOrders (symbol, since, limit, this.extend (request, params)); @@ -1229,7 +1229,7 @@ module.exports = class qtrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the qtrade api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'open': false }; return await this.fetchOrders (symbol, since, limit, this.extend (request, params)); @@ -1371,7 +1371,7 @@ module.exports = class qtrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the qtrade api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); let currency = undefined; @@ -1435,7 +1435,7 @@ module.exports = class qtrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch transfers for * @param {number|undefined} limit the maximum number of transfers structures to retrieve * @param {object} params extra parameters specific to the qtrade api endpoint - * @returns {[dict]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} + * @returns {[object]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} */ await this.loadMarkets (); let currency = undefined; @@ -1563,7 +1563,7 @@ module.exports = class qtrade extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the qtrade api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); let currency = undefined; @@ -1763,7 +1763,7 @@ module.exports = class qtrade extends Exchange { * @name qtrade#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the qtrade api endpoint diff --git a/js/ripio.js b/js/ripio.js index f35df0b256b2..3924c33f0110 100644 --- a/js/ripio.js +++ b/js/ripio.js @@ -150,7 +150,7 @@ module.exports = class ripio extends Exchange { * @name ripio#fetchMarkets * @description retrieves data on all markets for ripio * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetPair (params); // @@ -576,7 +576,7 @@ module.exports = class ripio extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the ripio api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -708,8 +708,8 @@ module.exports = class ripio extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 ripio api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -870,7 +870,7 @@ module.exports = class ripio extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the ripio api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -927,7 +927,7 @@ module.exports = class ripio extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the ripio api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'OPEN,PART', @@ -944,7 +944,7 @@ module.exports = class ripio extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the ripio api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'CLOS,CANC,COMP', @@ -1094,7 +1094,7 @@ module.exports = class ripio extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the ripio api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires a symbol argument'); diff --git a/js/therock.js b/js/therock.js index 506acd759ed0..b98bfc3aceb6 100644 --- a/js/therock.js +++ b/js/therock.js @@ -163,7 +163,7 @@ module.exports = class therock extends Exchange { * @name therock#fetchMarkets * @description retrieves data on all markets for therock * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetFunds (params); // @@ -900,7 +900,7 @@ module.exports = class therock extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the therock api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'type': 'withdraw', @@ -917,7 +917,7 @@ module.exports = class therock extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the therock api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'type': 'atm_payment', @@ -1029,7 +1029,7 @@ module.exports = class therock extends Exchange { * @name therock#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the therock api endpoint @@ -1193,7 +1193,7 @@ module.exports = class therock extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the therock api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'active', @@ -1210,7 +1210,7 @@ module.exports = class therock extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the therock api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const request = { 'status': 'executed', @@ -1227,7 +1227,7 @@ module.exports = class therock extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the therock api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -1332,8 +1332,8 @@ module.exports = class therock extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 therock api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1452,7 +1452,7 @@ module.exports = class therock extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the therock api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchMyTrades() requires a symbol argument'); @@ -1511,7 +1511,7 @@ module.exports = class therock extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the therock api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); diff --git a/js/timex.js b/js/timex.js index 440b0d36d4bd..a3d21c48a8be 100644 --- a/js/timex.js +++ b/js/timex.js @@ -240,7 +240,7 @@ module.exports = class timex extends Exchange { * @name timex#fetchMarkets * @description retrieves data on all markets for timex * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetMarkets (params); // @@ -442,7 +442,7 @@ module.exports = class timex extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the timex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -578,8 +578,8 @@ module.exports = class timex extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 timex api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -814,7 +814,7 @@ module.exports = class timex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the timex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const options = this.safeValue (this.options, 'fetchOpenOrders', {}); @@ -869,7 +869,7 @@ module.exports = class timex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the timex api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const options = this.safeValue (this.options, 'fetchClosedOrders', {}); @@ -929,7 +929,7 @@ module.exports = class timex extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the timex api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const options = this.safeValue (this.options, 'fetchMyTrades', {}); diff --git a/js/upbit.js b/js/upbit.js index a4b498ee2b32..e4c4a5fb70a0 100644 --- a/js/upbit.js +++ b/js/upbit.js @@ -397,7 +397,7 @@ module.exports = class upbit extends Exchange { * @name upbit#fetchMarkets * @description retrieves data on all markets for upbit * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetMarketAll (params); // @@ -815,7 +815,7 @@ module.exports = class upbit extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the upbit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1019,8 +1019,8 @@ module.exports = class upbit extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 upbit api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1138,7 +1138,7 @@ module.exports = class upbit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the upbit api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1182,7 +1182,7 @@ module.exports = class upbit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the upbit api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -1489,7 +1489,7 @@ module.exports = class upbit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the upbit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByState ('wait', symbol, since, limit, params); } @@ -1503,7 +1503,7 @@ module.exports = class upbit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the upbit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersByState ('done', symbol, since, limit, params); } @@ -1705,7 +1705,7 @@ module.exports = class upbit extends Exchange { * @name upbit#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the upbit api endpoint diff --git a/js/vcc.js b/js/vcc.js index 56bf65bca635..2a05101c2ae6 100644 --- a/js/vcc.js +++ b/js/vcc.js @@ -178,7 +178,7 @@ module.exports = class vcc extends Exchange { * @name vcc#fetchMarkets * @description retrieves data on all markets for vcc * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetExchangeInfo (params); // @@ -694,7 +694,7 @@ module.exports = class vcc extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the vcc api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -822,7 +822,7 @@ module.exports = class vcc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the vcc api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'type': 'deposit' }; return await this.fetchTransactions (code, since, limit, this.extend (request, params)); @@ -837,7 +837,7 @@ module.exports = class vcc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the vcc api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'type': 'withdraw' }; return await this.fetchTransactions (code, since, limit, this.extend (request, params)); @@ -954,8 +954,8 @@ module.exports = class vcc extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 vcc api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1069,7 +1069,7 @@ module.exports = class vcc extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 vcc api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ const type = this.safeString (params, 'type'); const method = (type === undefined) ? 'privatePutOrdersCancelAll' : 'privatePutOrdersCancelByType'; @@ -1339,7 +1339,7 @@ module.exports = class vcc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the vcc api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersWithMethod ('privateGetOrdersOpen', symbol, since, limit, params); } @@ -1353,7 +1353,7 @@ module.exports = class vcc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the vcc api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ return await this.fetchOrdersWithMethod ('privateGetOrders', symbol, since, limit, params); } @@ -1367,7 +1367,7 @@ module.exports = class vcc extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the vcc api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { diff --git a/js/wavesexchange.js b/js/wavesexchange.js index 0f0f66c4a750..b2c6f36b607d 100644 --- a/js/wavesexchange.js +++ b/js/wavesexchange.js @@ -477,7 +477,7 @@ module.exports = class wavesexchange extends Exchange { * @name wavesexchange#fetchMarkets * @description retrieves data on all markets for wavesexchange * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.marketGetTickers (); // @@ -1242,8 +1242,8 @@ module.exports = class wavesexchange extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 wavesexchange api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1487,7 +1487,7 @@ module.exports = class wavesexchange extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the wavesexchange api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ this.checkRequiredDependencies (); this.checkRequiredKeys (); @@ -1540,7 +1540,7 @@ module.exports = class wavesexchange extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the wavesexchange api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); await this.signIn (); @@ -1566,7 +1566,7 @@ module.exports = class wavesexchange extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the wavesexchange api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); await this.signIn (); @@ -1908,7 +1908,7 @@ module.exports = class wavesexchange extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the wavesexchange api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const address = await this.getWavesAddress (); @@ -2001,7 +2001,7 @@ module.exports = class wavesexchange extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the wavesexchange api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -2201,7 +2201,7 @@ module.exports = class wavesexchange extends Exchange { * @name wavesexchange#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the wavesexchange api endpoint diff --git a/js/wazirx.js b/js/wazirx.js index 994142455862..733eee09d278 100644 --- a/js/wazirx.js +++ b/js/wazirx.js @@ -137,7 +137,7 @@ module.exports = class wazirx extends Exchange { * @name wazirx#fetchMarkets * @description retrieves data on all markets for wazirx * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetExchangeInfo (params); // @@ -361,7 +361,7 @@ module.exports = class wazirx extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the wazirx api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -561,7 +561,7 @@ module.exports = class wazirx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the wazirx api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a `symbol` argument'); @@ -619,7 +619,7 @@ module.exports = class wazirx extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the wazirx api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -667,7 +667,7 @@ module.exports = class wazirx extends Exchange { * @description cancel all open orders in a market * @param {string} symbol unified market symbol of the market to cancel orders in * @param {object} params extra parameters specific to the wazirx api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' cancelAllOrders() requires a `symbol` argument'); @@ -711,8 +711,8 @@ module.exports = class wazirx extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 wazirx api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ diff --git a/js/whitebit.js b/js/whitebit.js index bd20903f3def..adf4042a028a 100644 --- a/js/whitebit.js +++ b/js/whitebit.js @@ -243,7 +243,7 @@ module.exports = class whitebit extends Exchange { * @name whitebit#fetchMarkets * @description retrieves data on all markets for whitebit * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.v2PublicGetMarkets (params); // @@ -671,7 +671,7 @@ module.exports = class whitebit extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the whitebit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -703,7 +703,7 @@ module.exports = class whitebit extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the whitebit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} */ await this.loadMarkets (); let market = undefined; @@ -969,8 +969,8 @@ module.exports = class whitebit extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 whitebit api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1101,7 +1101,7 @@ module.exports = class whitebit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the whitebit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -1147,7 +1147,7 @@ module.exports = class whitebit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the whitebit api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1307,7 +1307,7 @@ module.exports = class whitebit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the whitebit api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = { @@ -1423,7 +1423,7 @@ module.exports = class whitebit extends Exchange { * @method * @name whitebit#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the whitebit api endpoint * @returns {object} response from the exchange @@ -1450,7 +1450,7 @@ module.exports = class whitebit extends Exchange { * @name whitebit#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the whitebit api endpoint @@ -1513,7 +1513,7 @@ module.exports = class whitebit extends Exchange { * @name whitebit#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the whitebit api endpoint @@ -1709,7 +1709,7 @@ module.exports = class whitebit extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the whitebit api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); let currency = undefined; diff --git a/js/woo.js b/js/woo.js index 51bd001a186f..e7a97b8faac3 100644 --- a/js/woo.js +++ b/js/woo.js @@ -252,7 +252,7 @@ module.exports = class woo extends Exchange { * @name woo#fetchMarkets * @description retrieves data on all markets for woo * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.v1PublicGetInfo (params); // @@ -363,7 +363,7 @@ module.exports = class woo extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the woo api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchTrades() requires a symbol argument'); @@ -674,8 +674,8 @@ module.exports = class woo extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 woo api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -870,7 +870,7 @@ module.exports = class woo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the woo api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); const request = {}; @@ -1107,7 +1107,7 @@ module.exports = class woo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades to retrieve * @param {object} params extra parameters specific to the woo api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); let market = undefined; @@ -1149,7 +1149,7 @@ module.exports = class woo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the woo api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); const request = {}; @@ -1459,7 +1459,7 @@ module.exports = class woo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the woo api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'token_side': 'DEPOSIT', @@ -1476,7 +1476,7 @@ module.exports = class woo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the woo api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ const request = { 'token_side': 'WITHDRAW', @@ -1563,7 +1563,7 @@ module.exports = class woo extends Exchange { * @name woo#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the woo api endpoint @@ -1604,7 +1604,7 @@ module.exports = class woo extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch transfers for * @param {number|undefined} limit the maximum number of transfers structures to retrieve * @param {object} params extra parameters specific to the woo api endpoint - * @returns {[dict]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} + * @returns {[object]} a list of [transfer structures]{@link https://docs.ccxt.com/en/latest/manual.html#transfer-structure} */ const request = { 'type': 'COLLATERAL', @@ -1694,7 +1694,7 @@ module.exports = class woo extends Exchange { * @description repay borrowed margin and interest * @see https://docs.woo.org/#repay-interest * @param {string} code unified currency code of the currency to repay - * @param {float} amount the amount to repay + * @param {number} amount the amount to repay * @param {string|undefined} symbol not used by woo.repayMargin () * @param {object} params extra parameters specific to the woo api endpoint * @returns {object} a [margin loan structure]{@link https://docs.ccxt.com/en/latest/manual.html#margin-loan-structure} diff --git a/js/xena.js b/js/xena.js index 8551fed6b152..4b93b2ecb4a0 100644 --- a/js/xena.js +++ b/js/xena.js @@ -209,7 +209,7 @@ module.exports = class xena extends Exchange { * @name xena#fetchMarkets * @description retrieves data on all markets for xena * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const response = await this.publicGetCommonInstruments (params); // @@ -825,7 +825,7 @@ module.exports = class xena extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch trades for * @param {number|undefined} limit the maximum number of trades structures to retrieve * @param {object} params extra parameters specific to the xena api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html#trade-structure} */ await this.loadMarkets (); await this.loadAccounts (); @@ -985,7 +985,7 @@ module.exports = class xena extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the xena api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -1124,8 +1124,8 @@ module.exports = class xena extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 xena api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -1335,7 +1335,7 @@ module.exports = class xena extends Exchange { * @description cancel all open orders * @param {string|undefined} 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 xena api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); await this.loadAccounts (); @@ -1378,7 +1378,7 @@ module.exports = class xena extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the xena api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); await this.loadAccounts (); @@ -1429,7 +1429,7 @@ module.exports = class xena extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the xena api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); await this.loadAccounts (); @@ -1619,7 +1619,7 @@ module.exports = class xena extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the xena api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactionsByType ('withdrawals', code, since, limit, params); } @@ -1633,7 +1633,7 @@ module.exports = class xena extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the xena api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ return await this.fetchTransactionsByType ('deposits', code, since, limit, params); } @@ -1738,7 +1738,7 @@ module.exports = class xena extends Exchange { * @name xena#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the xena api endpoint diff --git a/js/zaif.js b/js/zaif.js index e39be99cd35d..4dd0aa874393 100644 --- a/js/zaif.js +++ b/js/zaif.js @@ -150,7 +150,7 @@ module.exports = class zaif extends Exchange { * @name zaif#fetchMarkets * @description retrieves data on all markets for zaif * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ const markets = await this.publicGetCurrencyPairsAll (params); // @@ -415,7 +415,7 @@ module.exports = class zaif extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the zaif api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @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); @@ -453,8 +453,8 @@ module.exports = class zaif extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 zaif api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -545,7 +545,7 @@ module.exports = class zaif extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the zaif api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -570,7 +570,7 @@ module.exports = class zaif extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the zaif api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ await this.loadMarkets (); let market = undefined; @@ -598,7 +598,7 @@ module.exports = class zaif extends Exchange { * @name zaif#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the zaif api endpoint diff --git a/js/zb.js b/js/zb.js index be9565ad6b24..dc2d591de19b 100644 --- a/js/zb.js +++ b/js/zb.js @@ -547,7 +547,7 @@ module.exports = class zb extends Exchange { * @name zb#fetchMarkets * @description retrieves data on all markets for zb * @param {object} params extra parameters specific to the exchange api endpoint - * @returns {[dict]} an array of objects representing market data + * @returns {[object]} an array of objects representing market data */ // // { @@ -1718,7 +1718,7 @@ module.exports = class zb extends Exchange { * @param {number|undefined} since timestamp in ms of the earliest trade to fetch * @param {number|undefined} limit the maximum amount of trades to fetch * @param {object} params extra parameters specific to the zb api endpoint - * @returns {[dict]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} + * @returns {[object]} a list of [trade structures]{@link https://docs.ccxt.com/en/latest/manual.html?#public-trades} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchTrades() requires a symbol argument'); @@ -1802,8 +1802,8 @@ module.exports = class zb extends Exchange { * @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|undefined} price the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders + * @param {number} amount how much of currency you want to trade in units of base currency + * @param {number|undefined} 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 zb api endpoint * @returns {object} an [order structure]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ @@ -2007,7 +2007,7 @@ module.exports = class zb extends Exchange { * @description cancel all open orders in a market * @param {string} symbol unified market symbol of the market to cancel orders in * @param {object} params extra parameters specific to the zb api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' cancelAllOrders() requires a symbol argument'); @@ -2178,7 +2178,7 @@ module.exports = class zb extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the zb api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOrders() requires a symbol argument'); @@ -2499,7 +2499,7 @@ module.exports = class zb extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch orders for * @param {number|undefined} limit the maximum number of orde structures to retrieve * @param {object} params extra parameters specific to the zb api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchClosedOrders() requires a symbol argument'); @@ -2617,7 +2617,7 @@ module.exports = class zb extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch open orders for * @param {number|undefined} limit the maximum number of open orders structures to retrieve * @param {object} params extra parameters specific to the zb api endpoint - * @returns {[dict]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} + * @returns {[object]} a list of [order structures]{@link https://docs.ccxt.com/en/latest/manual.html#order-structure} */ if (symbol === undefined) { throw new ArgumentsRequired (this.id + ' fetchOpenOrders() requires a symbol argument'); @@ -3079,7 +3079,7 @@ module.exports = class zb extends Exchange { * @method * @name zb#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the zb api endpoint * @returns {object} response from the exchange @@ -3116,7 +3116,7 @@ module.exports = class zb extends Exchange { * @param {number|undefined} limit the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} to fetch * @param {object} params extra parameters specific to the zb api endpoint * @param {number|undefined} params.until timestamp in ms of the latest funding rate to fetch - * @returns {[dict]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} + * @returns {[object]} a list of [funding rate structures]{@link https://docs.ccxt.com/en/latest/manual.html?#funding-rate-history-structure} */ await this.loadMarkets (); const request = { @@ -3287,7 +3287,7 @@ module.exports = class zb extends Exchange { * @name zb#withdraw * @description make a withdrawal * @param {string} code unified currency code - * @param {float} amount the amount to withdraw + * @param {number} amount the amount to withdraw * @param {string} address the address to withdraw to * @param {string|undefined} tag * @param {object} params extra parameters specific to the zb api endpoint @@ -3343,7 +3343,7 @@ module.exports = class zb extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch withdrawals for * @param {number|undefined} limit the maximum number of withdrawals structures to retrieve * @param {object} params extra parameters specific to the zb api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -3401,7 +3401,7 @@ module.exports = class zb extends Exchange { * @param {number|undefined} since the earliest time in ms to fetch deposits for * @param {number|undefined} limit the maximum number of deposits structures to retrieve * @param {object} params extra parameters specific to the zb api endpoint - * @returns {[dict]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} + * @returns {[object]} a list of [transaction structures]{@link https://docs.ccxt.com/en/latest/manual.html#transaction-structure} */ await this.loadMarkets (); const request = { @@ -3534,7 +3534,7 @@ module.exports = class zb extends Exchange { * @description fetch all open positions * @param {[str]|undefined} symbols list of unified market symbols * @param {object} params extra parameters specific to the zb api endpoint - * @returns {[dict]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} + * @returns {[object]} a list of [position structure]{@link https://docs.ccxt.com/en/latest/manual.html#position-structure} */ await this.loadMarkets (); const request = { @@ -3850,7 +3850,7 @@ module.exports = class zb extends Exchange { * @name zb#transfer * @description transfer currency internally between wallets on the same account * @param {string} code unified currency code - * @param {float} amount amount to transfer + * @param {number} amount amount to transfer * @param {string} fromAccount account to transfer from * @param {string} toAccount account to transfer to * @param {object} params extra parameters specific to the zb api endpoint @@ -4025,7 +4025,7 @@ module.exports = class zb extends Exchange { * @name zb#addMargin * @description add margin * @param {string} symbol unified market symbol - * @param {float} amount amount of margin to add + * @param {number} amount amount of margin to add * @param {object} params extra parameters specific to the zb api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#add-margin-structure} */ @@ -4041,7 +4041,7 @@ module.exports = class zb extends Exchange { * @name zb#reduceMargin * @description remove margin from a position * @param {string} symbol unified market symbol - * @param {float} amount the amount of margin to remove + * @param {number} amount the amount of margin to remove * @param {object} params extra parameters specific to the zb api endpoint * @returns {object} a [margin structure]{@link https://docs.ccxt.com/en/latest/manual.html#reduce-margin-structure} */ @@ -4152,7 +4152,7 @@ module.exports = class zb extends Exchange { * @method * @name zb#setLeverage * @description set the level of leverage for a market - * @param {float} leverage the rate of leverage + * @param {number} leverage the rate of leverage * @param {string} symbol unified market symbol * @param {object} params extra parameters specific to the zb api endpoint * @returns {object} response from the exchange @@ -4203,7 +4203,7 @@ module.exports = class zb extends Exchange { * @name zb#borrowMargin * @description create a loan to borrow margin * @param {string} code unified currency code of the currency to borrow - * @param {float} amount the amount to borrow + * @param {number} amount the amount to borrow * @param {string|undefined} symbol unified market symbol, required for isolated margin * @param {object} params extra parameters specific to the zb api endpoint * @param {string} params.safePwd transaction password, extra parameter required for cross margin