ccxt 4.1.64 → 4.1.65
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/ccxt.browser.js +2558 -2534
- package/dist/ccxt.browser.min.js +2 -2
- package/dist/cjs/ccxt.js +1 -1
- package/dist/cjs/src/ace.js +13 -13
- package/dist/cjs/src/alpaca.js +10 -10
- package/dist/cjs/src/ascendex.js +33 -33
- package/dist/cjs/src/base/Exchange.js +6 -6
- package/dist/cjs/src/bigone.js +23 -23
- package/dist/cjs/src/binance.js +68 -68
- package/dist/cjs/src/binanceus.js +1 -0
- package/dist/cjs/src/bingx.js +33 -33
- package/dist/cjs/src/bit2c.js +11 -11
- package/dist/cjs/src/bitbank.js +14 -14
- package/dist/cjs/src/bitbns.js +15 -15
- package/dist/cjs/src/bitfinex.js +24 -24
- package/dist/cjs/src/bitfinex2.js +30 -30
- package/dist/cjs/src/bitflyer.js +17 -17
- package/dist/cjs/src/bitforex.js +12 -12
- package/dist/cjs/src/bitget.js +50 -50
- package/dist/cjs/src/bithumb.js +13 -13
- package/dist/cjs/src/bitmart.js +74 -59
- package/dist/cjs/src/bitmex.js +29 -28
- package/dist/cjs/src/bitopro.js +23 -23
- package/dist/cjs/src/bitpanda.js +25 -25
- package/dist/cjs/src/bitrue.js +26 -26
- package/dist/cjs/src/bitso.js +22 -22
- package/dist/cjs/src/bitstamp.js +24 -24
- package/dist/cjs/src/bittrex.js +31 -31
- package/dist/cjs/src/bitvavo.js +23 -23
- package/dist/cjs/src/bl3p.js +7 -7
- package/dist/cjs/src/blockchaincom.js +23 -23
- package/dist/cjs/src/btcalpha.js +17 -17
- package/dist/cjs/src/btcbox.js +9 -9
- package/dist/cjs/src/btcmarkets.js +19 -19
- package/dist/cjs/src/btcturk.js +13 -13
- package/dist/cjs/src/bybit.js +71 -67
- package/dist/cjs/src/cex.js +17 -17
- package/dist/cjs/src/coinbase.js +28 -28
- package/dist/cjs/src/coinbasepro.js +27 -27
- package/dist/cjs/src/coincheck.js +11 -11
- package/dist/cjs/src/coinex.js +42 -42
- package/dist/cjs/src/coinlist.js +29 -29
- package/dist/cjs/src/coinmate.js +14 -14
- package/dist/cjs/src/coinone.js +13 -13
- package/dist/cjs/src/coinsph.js +25 -25
- package/dist/cjs/src/coinspot.js +9 -9
- package/dist/cjs/src/cryptocom.js +33 -32
- package/dist/cjs/src/currencycom.js +24 -24
- package/dist/cjs/src/delta.js +29 -29
- package/dist/cjs/src/deribit.js +35 -35
- package/dist/cjs/src/digifinex.js +43 -43
- package/dist/cjs/src/exmo.js +30 -30
- package/dist/cjs/src/gate.js +39 -39
- package/dist/cjs/src/gemini.js +18 -18
- package/dist/cjs/src/hitbtc.js +40 -40
- package/dist/cjs/src/hollaex.js +26 -26
- package/dist/cjs/src/htx.js +48 -48
- package/dist/cjs/src/huobijp.js +24 -24
- package/dist/cjs/src/idex.js +23 -23
- package/dist/cjs/src/independentreserve.js +12 -12
- package/dist/cjs/src/indodax.js +16 -16
- package/dist/cjs/src/kraken.js +28 -28
- package/dist/cjs/src/krakenfutures.js +9 -9
- package/dist/cjs/src/kucoin.js +39 -39
- package/dist/cjs/src/kucoinfutures.js +24 -24
- package/dist/cjs/src/kuna.js +25 -25
- package/dist/cjs/src/latoken.js +20 -20
- package/dist/cjs/src/lbank.js +24 -24
- package/dist/cjs/src/luno.js +17 -17
- package/dist/cjs/src/lykke.js +18 -18
- package/dist/cjs/src/mercado.js +13 -13
- package/dist/cjs/src/mexc.js +47 -45
- package/dist/cjs/src/ndax.js +23 -23
- package/dist/cjs/src/novadax.js +23 -23
- package/dist/cjs/src/oceanex.js +19 -19
- package/dist/cjs/src/okcoin.js +25 -25
- package/dist/cjs/src/okx.js +53 -53
- package/dist/cjs/src/p2b.js +14 -14
- package/dist/cjs/src/paymium.js +10 -10
- package/dist/cjs/src/phemex.js +32 -32
- package/dist/cjs/src/poloniex.js +27 -27
- package/dist/cjs/src/poloniexfutures.js +21 -21
- package/dist/cjs/src/pro/alpaca.js +6 -6
- package/dist/cjs/src/pro/ascendex.js +5 -5
- package/dist/cjs/src/pro/binance.js +21 -21
- package/dist/cjs/src/pro/bingx.js +6 -6
- package/dist/cjs/src/pro/bitfinex.js +4 -4
- package/dist/cjs/src/pro/bitfinex2.js +7 -7
- package/dist/cjs/src/pro/bitget.js +12 -12
- package/dist/cjs/src/pro/bitmart.js +5 -5
- package/dist/cjs/src/pro/bitmex.js +8 -8
- package/dist/cjs/src/pro/bitopro.js +4 -4
- package/dist/cjs/src/pro/bitpanda.js +7 -7
- package/dist/cjs/src/pro/bitrue.js +2 -2
- package/dist/cjs/src/pro/bitstamp.js +3 -3
- package/dist/cjs/src/pro/bittrex.js +7 -7
- package/dist/cjs/src/pro/bitvavo.js +6 -6
- package/dist/cjs/src/pro/blockchaincom.js +6 -6
- package/dist/cjs/src/pro/bybit.js +12 -12
- package/dist/cjs/src/pro/cex.js +9 -9
- package/dist/cjs/src/pro/coinbase.js +6 -6
- package/dist/cjs/src/pro/coinbasepro.js +10 -10
- package/dist/cjs/src/pro/coinex.js +7 -7
- package/dist/cjs/src/pro/cryptocom.js +13 -13
- package/dist/cjs/src/pro/currencycom.js +5 -5
- package/dist/cjs/src/pro/deribit.js +7 -7
- package/dist/cjs/src/pro/exmo.js +5 -5
- package/dist/cjs/src/pro/gate.js +10 -10
- package/dist/cjs/src/pro/gemini.js +4 -4
- package/dist/cjs/src/pro/hitbtc.js +11 -11
- package/dist/cjs/src/pro/hollaex.js +5 -5
- package/dist/cjs/src/pro/htx.js +8 -8
- package/dist/cjs/src/pro/huobijp.js +4 -4
- package/dist/cjs/src/pro/idex.js +5 -5
- package/dist/cjs/src/pro/independentreserve.js +2 -2
- package/dist/cjs/src/pro/kraken.js +11 -11
- package/dist/cjs/src/pro/krakenfutures.js +8 -8
- package/dist/cjs/src/pro/kucoin.js +10 -10
- package/dist/cjs/src/pro/kucoinfutures.js +8 -8
- package/dist/cjs/src/pro/luno.js +4 -4
- package/dist/cjs/src/pro/mexc.js +7 -7
- package/dist/cjs/src/pro/ndax.js +4 -4
- package/dist/cjs/src/pro/okcoin.js +6 -6
- package/dist/cjs/src/pro/okx.js +16 -16
- package/dist/cjs/src/pro/phemex.js +7 -7
- package/dist/cjs/src/pro/poloniex.js +7 -7
- package/dist/cjs/src/pro/poloniexfutures.js +5 -5
- package/dist/cjs/src/pro/probit.js +6 -6
- package/dist/cjs/src/pro/upbit.js +3 -3
- package/dist/cjs/src/pro/wazirx.js +7 -7
- package/dist/cjs/src/pro/whitebit.js +7 -7
- package/dist/cjs/src/pro/woo.js +1 -1
- package/dist/cjs/src/probit.js +24 -24
- package/dist/cjs/src/tidex.js +15 -15
- package/dist/cjs/src/timex.js +19 -19
- package/dist/cjs/src/tokocrypto.js +21 -21
- package/dist/cjs/src/upbit.js +22 -22
- package/dist/cjs/src/wavesexchange.js +19 -19
- package/dist/cjs/src/wazirx.js +15 -15
- package/dist/cjs/src/whitebit.js +29 -29
- package/dist/cjs/src/woo.js +26 -26
- package/dist/cjs/src/yobit.js +17 -17
- package/dist/cjs/src/zaif.js +10 -10
- package/dist/cjs/src/zonda.js +16 -16
- package/js/ccxt.d.ts +1 -1
- package/js/ccxt.js +1 -1
- package/js/src/abstract/mexc.d.ts +2 -0
- package/js/src/ace.js +13 -13
- package/js/src/alpaca.js +10 -10
- package/js/src/ascendex.js +33 -33
- package/js/src/base/Exchange.js +6 -6
- package/js/src/bigone.js +23 -23
- package/js/src/binance.js +68 -68
- package/js/src/binanceus.js +1 -0
- package/js/src/bingx.js +33 -33
- package/js/src/bit2c.js +11 -11
- package/js/src/bitbank.js +14 -14
- package/js/src/bitbns.js +15 -15
- package/js/src/bitfinex.js +24 -24
- package/js/src/bitfinex2.js +30 -30
- package/js/src/bitflyer.js +17 -17
- package/js/src/bitforex.js +12 -12
- package/js/src/bitget.js +50 -50
- package/js/src/bithumb.js +13 -13
- package/js/src/bitmart.js +74 -59
- package/js/src/bitmex.js +29 -28
- package/js/src/bitopro.js +23 -23
- package/js/src/bitpanda.js +25 -25
- package/js/src/bitrue.js +26 -26
- package/js/src/bitso.js +22 -22
- package/js/src/bitstamp.js +24 -24
- package/js/src/bittrex.js +31 -31
- package/js/src/bitvavo.js +23 -23
- package/js/src/bl3p.js +7 -7
- package/js/src/blockchaincom.js +23 -23
- package/js/src/btcalpha.js +17 -17
- package/js/src/btcbox.js +9 -9
- package/js/src/btcmarkets.js +19 -19
- package/js/src/btcturk.js +13 -13
- package/js/src/bybit.js +71 -67
- package/js/src/cex.js +17 -17
- package/js/src/coinbase.js +28 -28
- package/js/src/coinbasepro.js +27 -27
- package/js/src/coincheck.js +11 -11
- package/js/src/coinex.js +42 -42
- package/js/src/coinlist.js +29 -29
- package/js/src/coinmate.js +14 -14
- package/js/src/coinone.js +13 -13
- package/js/src/coinsph.js +25 -25
- package/js/src/coinspot.js +9 -9
- package/js/src/cryptocom.js +33 -32
- package/js/src/currencycom.js +24 -24
- package/js/src/delta.js +29 -29
- package/js/src/deribit.js +35 -35
- package/js/src/digifinex.js +43 -43
- package/js/src/exmo.js +30 -30
- package/js/src/gate.js +39 -39
- package/js/src/gemini.js +18 -18
- package/js/src/hitbtc.js +40 -40
- package/js/src/hollaex.js +26 -26
- package/js/src/htx.js +48 -48
- package/js/src/huobijp.js +24 -24
- package/js/src/idex.js +23 -23
- package/js/src/independentreserve.js +12 -12
- package/js/src/indodax.js +16 -16
- package/js/src/kraken.js +28 -28
- package/js/src/krakenfutures.js +9 -9
- package/js/src/kucoin.js +39 -39
- package/js/src/kucoinfutures.js +24 -24
- package/js/src/kuna.js +25 -25
- package/js/src/latoken.js +20 -20
- package/js/src/lbank.js +24 -24
- package/js/src/luno.js +17 -17
- package/js/src/lykke.js +18 -18
- package/js/src/mercado.js +13 -13
- package/js/src/mexc.js +47 -45
- package/js/src/ndax.js +23 -23
- package/js/src/novadax.js +23 -23
- package/js/src/oceanex.js +19 -19
- package/js/src/okcoin.js +25 -25
- package/js/src/okx.js +53 -53
- package/js/src/p2b.js +14 -14
- package/js/src/paymium.js +10 -10
- package/js/src/phemex.js +32 -32
- package/js/src/poloniex.js +27 -27
- package/js/src/poloniexfutures.js +21 -21
- package/js/src/pro/alpaca.js +6 -6
- package/js/src/pro/ascendex.js +5 -5
- package/js/src/pro/binance.js +21 -21
- package/js/src/pro/bingx.js +6 -6
- package/js/src/pro/bitfinex.js +4 -4
- package/js/src/pro/bitfinex2.js +7 -7
- package/js/src/pro/bitget.js +12 -12
- package/js/src/pro/bitmart.js +5 -5
- package/js/src/pro/bitmex.js +8 -8
- package/js/src/pro/bitopro.js +4 -4
- package/js/src/pro/bitpanda.js +7 -7
- package/js/src/pro/bitrue.js +2 -2
- package/js/src/pro/bitstamp.js +3 -3
- package/js/src/pro/bittrex.js +7 -7
- package/js/src/pro/bitvavo.js +6 -6
- package/js/src/pro/blockchaincom.js +6 -6
- package/js/src/pro/bybit.js +12 -12
- package/js/src/pro/cex.js +9 -9
- package/js/src/pro/coinbase.js +6 -6
- package/js/src/pro/coinbasepro.js +10 -10
- package/js/src/pro/coinex.js +7 -7
- package/js/src/pro/cryptocom.js +13 -13
- package/js/src/pro/currencycom.js +5 -5
- package/js/src/pro/deribit.js +7 -7
- package/js/src/pro/exmo.js +5 -5
- package/js/src/pro/gate.js +10 -10
- package/js/src/pro/gemini.js +4 -4
- package/js/src/pro/hitbtc.js +11 -11
- package/js/src/pro/hollaex.js +5 -5
- package/js/src/pro/htx.js +8 -8
- package/js/src/pro/huobijp.js +4 -4
- package/js/src/pro/idex.js +5 -5
- package/js/src/pro/independentreserve.js +2 -2
- package/js/src/pro/kraken.js +11 -11
- package/js/src/pro/krakenfutures.js +8 -8
- package/js/src/pro/kucoin.js +10 -10
- package/js/src/pro/kucoinfutures.js +8 -8
- package/js/src/pro/luno.js +4 -4
- package/js/src/pro/mexc.js +7 -7
- package/js/src/pro/ndax.js +4 -4
- package/js/src/pro/okcoin.js +6 -6
- package/js/src/pro/okx.js +16 -16
- package/js/src/pro/phemex.js +7 -7
- package/js/src/pro/poloniex.js +7 -7
- package/js/src/pro/poloniexfutures.js +5 -5
- package/js/src/pro/probit.js +6 -6
- package/js/src/pro/upbit.js +3 -3
- package/js/src/pro/wazirx.js +7 -7
- package/js/src/pro/whitebit.js +7 -7
- package/js/src/pro/woo.js +1 -1
- package/js/src/probit.js +24 -24
- package/js/src/tidex.js +15 -15
- package/js/src/timex.js +19 -19
- package/js/src/tokocrypto.js +21 -21
- package/js/src/upbit.js +22 -22
- package/js/src/wavesexchange.js +19 -19
- package/js/src/wazirx.js +15 -15
- package/js/src/whitebit.js +29 -29
- package/js/src/woo.js +26 -26
- package/js/src/yobit.js +17 -17
- package/js/src/zaif.js +10 -10
- package/js/src/zonda.js +16 -16
- package/package.json +1 -1
package/dist/cjs/src/paymium.js
CHANGED
|
@@ -136,7 +136,7 @@ class paymium extends paymium$1 {
|
|
|
136
136
|
* @name paymium#fetchBalance
|
|
137
137
|
* @description query for balance and get the amount of funds available for trading or funds locked in orders
|
|
138
138
|
* @see https://paymium.github.io/api-documentation/#tag/User/paths/~1user/get
|
|
139
|
-
* @param {object} [params] extra parameters specific to the
|
|
139
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
140
140
|
* @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
|
|
141
141
|
*/
|
|
142
142
|
await this.loadMarkets();
|
|
@@ -151,7 +151,7 @@ class paymium extends paymium$1 {
|
|
|
151
151
|
* @see https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1depth/get
|
|
152
152
|
* @param {string} symbol unified symbol of the market to fetch the order book for
|
|
153
153
|
* @param {int} [limit] the maximum amount of order book entries to return
|
|
154
|
-
* @param {object} [params] extra parameters specific to the
|
|
154
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
155
155
|
* @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
|
|
156
156
|
*/
|
|
157
157
|
await this.loadMarkets();
|
|
@@ -217,7 +217,7 @@ class paymium extends paymium$1 {
|
|
|
217
217
|
* @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
|
|
218
218
|
* @see https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1ticker/get
|
|
219
219
|
* @param {string} symbol unified symbol of the market to fetch the ticker for
|
|
220
|
-
* @param {object} [params] extra parameters specific to the
|
|
220
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
221
221
|
* @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
|
|
222
222
|
*/
|
|
223
223
|
await this.loadMarkets();
|
|
@@ -279,7 +279,7 @@ class paymium extends paymium$1 {
|
|
|
279
279
|
* @param {string} symbol unified symbol of the market to fetch trades for
|
|
280
280
|
* @param {int} [since] timestamp in ms of the earliest trade to fetch
|
|
281
281
|
* @param {int} [limit] the maximum amount of trades to fetch
|
|
282
|
-
* @param {object} [params] extra parameters specific to the
|
|
282
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
283
283
|
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
|
|
284
284
|
*/
|
|
285
285
|
await this.loadMarkets();
|
|
@@ -297,7 +297,7 @@ class paymium extends paymium$1 {
|
|
|
297
297
|
* @description create a currency deposit address
|
|
298
298
|
* @see https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses/post
|
|
299
299
|
* @param {string} code unified currency code of the currency for the deposit address
|
|
300
|
-
* @param {object} [params] extra parameters specific to the
|
|
300
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
301
301
|
* @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
|
|
302
302
|
*/
|
|
303
303
|
await this.loadMarkets();
|
|
@@ -319,7 +319,7 @@ class paymium extends paymium$1 {
|
|
|
319
319
|
* @description fetch the deposit address for a currency associated with this account
|
|
320
320
|
* @see https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses~1%7Baddress%7D/get
|
|
321
321
|
* @param {string} code unified currency code
|
|
322
|
-
* @param {object} [params] extra parameters specific to the
|
|
322
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
323
323
|
* @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
|
|
324
324
|
*/
|
|
325
325
|
await this.loadMarkets();
|
|
@@ -344,7 +344,7 @@ class paymium extends paymium$1 {
|
|
|
344
344
|
* @description fetch deposit addresses for multiple currencies and chain types
|
|
345
345
|
* @see https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses/get
|
|
346
346
|
* @param {string[]|undefined} codes list of unified currency codes, default is undefined
|
|
347
|
-
* @param {object} [params] extra parameters specific to the
|
|
347
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
348
348
|
* @returns {object} a list of [address structures]{@link https://docs.ccxt.com/#/?id=address-structure}
|
|
349
349
|
*/
|
|
350
350
|
await this.loadMarkets();
|
|
@@ -391,7 +391,7 @@ class paymium extends paymium$1 {
|
|
|
391
391
|
* @param {string} side 'buy' or 'sell'
|
|
392
392
|
* @param {float} amount how much of currency you want to trade in units of base currency
|
|
393
393
|
* @param {float} [price] the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders
|
|
394
|
-
* @param {object} [params] extra parameters specific to the
|
|
394
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
395
395
|
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
396
396
|
*/
|
|
397
397
|
await this.loadMarkets();
|
|
@@ -420,7 +420,7 @@ class paymium extends paymium$1 {
|
|
|
420
420
|
* @see https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders~1%7Buuid%7D~1cancel/delete
|
|
421
421
|
* @param {string} id order id
|
|
422
422
|
* @param {string} symbol not used by paymium cancelOrder ()
|
|
423
|
-
* @param {object} [params] extra parameters specific to the
|
|
423
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
424
424
|
* @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
425
425
|
*/
|
|
426
426
|
const request = {
|
|
@@ -438,7 +438,7 @@ class paymium extends paymium$1 {
|
|
|
438
438
|
* @param {float} amount amount to transfer
|
|
439
439
|
* @param {string} fromAccount account to transfer from
|
|
440
440
|
* @param {string} toAccount account to transfer to
|
|
441
|
-
* @param {object} [params] extra parameters specific to the
|
|
441
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
442
442
|
* @returns {object} a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
|
|
443
443
|
*/
|
|
444
444
|
await this.loadMarkets();
|
package/dist/cjs/src/phemex.js
CHANGED
|
@@ -710,7 +710,7 @@ class phemex extends phemex$1 {
|
|
|
710
710
|
* @method
|
|
711
711
|
* @name phemex#fetchMarkets
|
|
712
712
|
* @description retrieves data on all markets for phemex
|
|
713
|
-
* @param {object} [params] extra parameters specific to the exchange
|
|
713
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
714
714
|
* @returns {object[]} an array of objects representing market data
|
|
715
715
|
*/
|
|
716
716
|
const v2Products = await this.publicGetCfgV2Products(params);
|
|
@@ -870,7 +870,7 @@ class phemex extends phemex$1 {
|
|
|
870
870
|
* @method
|
|
871
871
|
* @name phemex#fetchCurrencies
|
|
872
872
|
* @description fetches all available currencies on an exchange
|
|
873
|
-
* @param {object} [params] extra parameters specific to the
|
|
873
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
874
874
|
* @returns {object} an associative dictionary of currencies
|
|
875
875
|
*/
|
|
876
876
|
const response = await this.publicGetCfgV2Products(params);
|
|
@@ -977,7 +977,7 @@ class phemex extends phemex$1 {
|
|
|
977
977
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#queryorderbook
|
|
978
978
|
* @param {string} symbol unified symbol of the market to fetch the order book for
|
|
979
979
|
* @param {int} [limit] the maximum amount of order book entries to return
|
|
980
|
-
* @param {object} [params] extra parameters specific to the
|
|
980
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
981
981
|
* @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
|
|
982
982
|
*/
|
|
983
983
|
await this.loadMarkets();
|
|
@@ -1113,7 +1113,7 @@ class phemex extends phemex$1 {
|
|
|
1113
1113
|
* @param {string} timeframe the length of time each candle represents
|
|
1114
1114
|
* @param {int} [since] *only used for USDT settled contracts, otherwise is emulated and not supported by the exchange* timestamp in ms of the earliest candle to fetch
|
|
1115
1115
|
* @param {int} [limit] the maximum amount of candles to fetch
|
|
1116
|
-
* @param {object} [params] extra parameters specific to the
|
|
1116
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1117
1117
|
* @param {int} [params.until] *USDT settled/ linear swaps only* end time in ms
|
|
1118
1118
|
* @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
|
|
1119
1119
|
*/
|
|
@@ -1288,7 +1288,7 @@ class phemex extends phemex$1 {
|
|
|
1288
1288
|
* @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
|
|
1289
1289
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query24hrsticker
|
|
1290
1290
|
* @param {string} symbol unified symbol of the market to fetch the ticker for
|
|
1291
|
-
* @param {object} [params] extra parameters specific to the
|
|
1291
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1292
1292
|
* @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
|
|
1293
1293
|
*/
|
|
1294
1294
|
await this.loadMarkets();
|
|
@@ -1360,12 +1360,12 @@ class phemex extends phemex$1 {
|
|
|
1360
1360
|
/**
|
|
1361
1361
|
* @method
|
|
1362
1362
|
* @name phemex#fetchTickers
|
|
1363
|
-
* @description fetches price tickers for multiple markets, statistical
|
|
1363
|
+
* @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
|
|
1364
1364
|
* @see https://phemex-docs.github.io/#query-24-hours-ticker-for-all-symbols-2 // spot
|
|
1365
1365
|
* @see https://phemex-docs.github.io/#query-24-ticker-for-all-symbols // linear
|
|
1366
1366
|
* @see https://phemex-docs.github.io/#query-24-hours-ticker-for-all-symbols // inverse
|
|
1367
1367
|
* @param {string[]|undefined} symbols unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
|
|
1368
|
-
* @param {object} [params] extra parameters specific to the
|
|
1368
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1369
1369
|
* @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
|
|
1370
1370
|
*/
|
|
1371
1371
|
await this.loadMarkets();
|
|
@@ -1401,7 +1401,7 @@ class phemex extends phemex$1 {
|
|
|
1401
1401
|
* @param {string} symbol unified symbol of the market to fetch trades for
|
|
1402
1402
|
* @param {int} [since] timestamp in ms of the earliest trade to fetch
|
|
1403
1403
|
* @param {int} [limit] the maximum amount of trades to fetch
|
|
1404
|
-
* @param {object} [params] extra parameters specific to the
|
|
1404
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1405
1405
|
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
|
|
1406
1406
|
*/
|
|
1407
1407
|
await this.loadMarkets();
|
|
@@ -1812,7 +1812,7 @@ class phemex extends phemex$1 {
|
|
|
1812
1812
|
* @name phemex#fetchBalance
|
|
1813
1813
|
* @description query for balance and get the amount of funds available for trading or funds locked in orders
|
|
1814
1814
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query-account-positions
|
|
1815
|
-
* @param {object} [params] extra parameters specific to the
|
|
1815
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1816
1816
|
* @param {string} [params.type] spot or swap
|
|
1817
1817
|
* @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
|
|
1818
1818
|
*/
|
|
@@ -2328,7 +2328,7 @@ class phemex extends phemex$1 {
|
|
|
2328
2328
|
* @param {string} side 'buy' or 'sell'
|
|
2329
2329
|
* @param {float} amount how much of currency you want to trade in units of base currency
|
|
2330
2330
|
* @param {float} [price] the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders
|
|
2331
|
-
* @param {object} [params] extra parameters specific to the
|
|
2331
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2332
2332
|
* @param {object} [params.takeProfit] *swap only* *takeProfit object in params* containing the triggerPrice at which the attached take profit order will be triggered (perpetual swap markets only)
|
|
2333
2333
|
* @param {float} [params.takeProfit.triggerPrice] take profit trigger price
|
|
2334
2334
|
* @param {object} [params.stopLoss] *swap only* *stopLoss object in params* containing the triggerPrice at which the attached stop loss order will be triggered (perpetual swap markets only)
|
|
@@ -2630,7 +2630,7 @@ class phemex extends phemex$1 {
|
|
|
2630
2630
|
* @param {string} side 'buy' or 'sell'
|
|
2631
2631
|
* @param {float} amount how much of currency you want to trade in units of base currency
|
|
2632
2632
|
* @param {float} [price] the price at which the order is to be fullfilled, in units of the base currency, ignored in market orders
|
|
2633
|
-
* @param {object} [params] extra parameters specific to the
|
|
2633
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2634
2634
|
* @param {string} [params.posSide] either 'Merged' or 'Long' or 'Short'
|
|
2635
2635
|
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
2636
2636
|
*/
|
|
@@ -2705,7 +2705,7 @@ class phemex extends phemex$1 {
|
|
|
2705
2705
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#cancel-single-order-by-orderid
|
|
2706
2706
|
* @param {string} id order id
|
|
2707
2707
|
* @param {string} symbol unified symbol of the market the order was made in
|
|
2708
|
-
* @param {object} [params] extra parameters specific to the
|
|
2708
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2709
2709
|
* @param {string} [params.posSide] either 'Merged' or 'Long' or 'Short'
|
|
2710
2710
|
* @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
2711
2711
|
*/
|
|
@@ -2749,7 +2749,7 @@ class phemex extends phemex$1 {
|
|
|
2749
2749
|
* @description cancel all open orders in a market
|
|
2750
2750
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#cancelall
|
|
2751
2751
|
* @param {string} symbol unified market symbol of the market to cancel orders in
|
|
2752
|
-
* @param {object} [params] extra parameters specific to the
|
|
2752
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2753
2753
|
* @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
2754
2754
|
*/
|
|
2755
2755
|
if (symbol === undefined) {
|
|
@@ -2780,7 +2780,7 @@ class phemex extends phemex$1 {
|
|
|
2780
2780
|
* @name phemex#fetchOrder
|
|
2781
2781
|
* @description fetches information on an order made by the user
|
|
2782
2782
|
* @param {string} symbol unified symbol of the market the order was made in
|
|
2783
|
-
* @param {object} [params] extra parameters specific to the
|
|
2783
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2784
2784
|
* @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
2785
2785
|
*/
|
|
2786
2786
|
if (symbol === undefined) {
|
|
@@ -2834,7 +2834,7 @@ class phemex extends phemex$1 {
|
|
|
2834
2834
|
* @param {string} symbol unified market symbol of the market orders were made in
|
|
2835
2835
|
* @param {int} [since] the earliest time in ms to fetch orders for
|
|
2836
2836
|
* @param {int} [limit] the maximum number of order structures to retrieve
|
|
2837
|
-
* @param {object} [params] extra parameters specific to the
|
|
2837
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2838
2838
|
* @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
2839
2839
|
*/
|
|
2840
2840
|
if (symbol === undefined) {
|
|
@@ -2876,7 +2876,7 @@ class phemex extends phemex$1 {
|
|
|
2876
2876
|
* @param {string} symbol unified market symbol
|
|
2877
2877
|
* @param {int} [since] the earliest time in ms to fetch open orders for
|
|
2878
2878
|
* @param {int} [limit] the maximum number of open order structures to retrieve
|
|
2879
|
-
* @param {object} [params] extra parameters specific to the
|
|
2879
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2880
2880
|
* @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
2881
2881
|
*/
|
|
2882
2882
|
if (symbol === undefined) {
|
|
@@ -2923,7 +2923,7 @@ class phemex extends phemex$1 {
|
|
|
2923
2923
|
* @param {string} symbol unified market symbol of the market orders were made in
|
|
2924
2924
|
* @param {int} [since] the earliest time in ms to fetch orders for
|
|
2925
2925
|
* @param {int} [limit] the maximum number of order structures to retrieve
|
|
2926
|
-
* @param {object} [params] extra parameters specific to the
|
|
2926
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2927
2927
|
* @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
2928
2928
|
*/
|
|
2929
2929
|
if (symbol === undefined) {
|
|
@@ -3006,7 +3006,7 @@ class phemex extends phemex$1 {
|
|
|
3006
3006
|
* @param {string} symbol unified market symbol
|
|
3007
3007
|
* @param {int} [since] the earliest time in ms to fetch trades for
|
|
3008
3008
|
* @param {int} [limit] the maximum number of trades structures to retrieve
|
|
3009
|
-
* @param {object} [params] extra parameters specific to the
|
|
3009
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3010
3010
|
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
|
|
3011
3011
|
*/
|
|
3012
3012
|
if (symbol === undefined) {
|
|
@@ -3168,7 +3168,7 @@ class phemex extends phemex$1 {
|
|
|
3168
3168
|
* @name phemex#fetchDepositAddress
|
|
3169
3169
|
* @description fetch the deposit address for a currency associated with this account
|
|
3170
3170
|
* @param {string} code unified currency code
|
|
3171
|
-
* @param {object} [params] extra parameters specific to the
|
|
3171
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3172
3172
|
* @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
|
|
3173
3173
|
*/
|
|
3174
3174
|
await this.loadMarkets();
|
|
@@ -3218,7 +3218,7 @@ class phemex extends phemex$1 {
|
|
|
3218
3218
|
* @param {string} code unified currency code
|
|
3219
3219
|
* @param {int} [since] the earliest time in ms to fetch deposits for
|
|
3220
3220
|
* @param {int} [limit] the maximum number of deposits structures to retrieve
|
|
3221
|
-
* @param {object} [params] extra parameters specific to the
|
|
3221
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3222
3222
|
* @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
|
3223
3223
|
*/
|
|
3224
3224
|
await this.loadMarkets();
|
|
@@ -3258,7 +3258,7 @@ class phemex extends phemex$1 {
|
|
|
3258
3258
|
* @param {string} code unified currency code
|
|
3259
3259
|
* @param {int} [since] the earliest time in ms to fetch withdrawals for
|
|
3260
3260
|
* @param {int} [limit] the maximum number of withdrawals structures to retrieve
|
|
3261
|
-
* @param {object} [params] extra parameters specific to the
|
|
3261
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3262
3262
|
* @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
|
3263
3263
|
*/
|
|
3264
3264
|
await this.loadMarkets();
|
|
@@ -3384,7 +3384,7 @@ class phemex extends phemex$1 {
|
|
|
3384
3384
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#query-trading-account-and-positions
|
|
3385
3385
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#query-account-positions
|
|
3386
3386
|
* @param {string[]|undefined} symbols list of unified market symbols
|
|
3387
|
-
* @param {object} [params] extra parameters specific to the
|
|
3387
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3388
3388
|
* @returns {object[]} a list of [position structure]{@link https://docs.ccxt.com/#/?id=position-structure}
|
|
3389
3389
|
*/
|
|
3390
3390
|
await this.loadMarkets();
|
|
@@ -3663,7 +3663,7 @@ class phemex extends phemex$1 {
|
|
|
3663
3663
|
* @param {string} symbol unified market symbol
|
|
3664
3664
|
* @param {int} [since] the earliest time in ms to fetch funding history for
|
|
3665
3665
|
* @param {int} [limit] the maximum number of funding history structures to retrieve
|
|
3666
|
-
* @param {object} [params] extra parameters specific to the
|
|
3666
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3667
3667
|
* @returns {object} a [funding history structure]{@link https://docs.ccxt.com/#/?id=funding-history-structure}
|
|
3668
3668
|
*/
|
|
3669
3669
|
if (symbol === undefined) {
|
|
@@ -3735,7 +3735,7 @@ class phemex extends phemex$1 {
|
|
|
3735
3735
|
* @name phemex#fetchFundingRate
|
|
3736
3736
|
* @description fetch the current funding rate
|
|
3737
3737
|
* @param {string} symbol unified market symbol
|
|
3738
|
-
* @param {object} [params] extra parameters specific to the
|
|
3738
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3739
3739
|
* @returns {object} a [funding rate structure]{@link https://docs.ccxt.com/#/?id=funding-rate-structure}
|
|
3740
3740
|
*/
|
|
3741
3741
|
await this.loadMarkets();
|
|
@@ -3848,7 +3848,7 @@ class phemex extends phemex$1 {
|
|
|
3848
3848
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Contract-API-en.md#assign-position-balance-in-isolated-marign-mode
|
|
3849
3849
|
* @param {string} symbol unified market symbol of the market to set margin in
|
|
3850
3850
|
* @param {float} amount the amount to set the margin to
|
|
3851
|
-
* @param {object} [params] parameters specific to the
|
|
3851
|
+
* @param {object} [params] parameters specific to the exchange API endpoint
|
|
3852
3852
|
* @returns {object} A [margin structure]{@link https://docs.ccxt.com/#/?id=add-margin-structure}
|
|
3853
3853
|
*/
|
|
3854
3854
|
await this.loadMarkets();
|
|
@@ -3903,7 +3903,7 @@ class phemex extends phemex$1 {
|
|
|
3903
3903
|
* @description set margin mode to 'cross' or 'isolated'
|
|
3904
3904
|
* @param {string} marginMode 'cross' or 'isolated'
|
|
3905
3905
|
* @param {string} symbol unified market symbol
|
|
3906
|
-
* @param {object} [params] extra parameters specific to the
|
|
3906
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3907
3907
|
* @returns {object} response from the exchange
|
|
3908
3908
|
*/
|
|
3909
3909
|
if (symbol === undefined) {
|
|
@@ -3939,7 +3939,7 @@ class phemex extends phemex$1 {
|
|
|
3939
3939
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#switch-position-mode-synchronously
|
|
3940
3940
|
* @param {bool} hedged set to true to use dualSidePosition
|
|
3941
3941
|
* @param {string} symbol not used by binance setPositionMode ()
|
|
3942
|
-
* @param {object} [params] extra parameters specific to the
|
|
3942
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3943
3943
|
* @returns {object} response from the exchange
|
|
3944
3944
|
*/
|
|
3945
3945
|
this.checkRequiredArgument('setPositionMode', symbol, 'symbol');
|
|
@@ -3965,7 +3965,7 @@ class phemex extends phemex$1 {
|
|
|
3965
3965
|
* @name phemex#fetchLeverageTiers
|
|
3966
3966
|
* @description retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes
|
|
3967
3967
|
* @param {string[]|undefined} symbols list of unified market symbols
|
|
3968
|
-
* @param {object} [params] extra parameters specific to the
|
|
3968
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
3969
3969
|
* @returns {object} a dictionary of [leverage tiers structures]{@link https://docs.ccxt.com/#/?id=leverage-tiers-structure}, indexed by market symbols
|
|
3970
3970
|
*/
|
|
3971
3971
|
await this.loadMarkets();
|
|
@@ -4136,7 +4136,7 @@ class phemex extends phemex$1 {
|
|
|
4136
4136
|
* @see https://github.com/phemex/phemex-api-docs/blob/master/Public-Hedged-Perpetual-API.md#set-leverage
|
|
4137
4137
|
* @param {float} leverage the rate of leverage
|
|
4138
4138
|
* @param {string} symbol unified market symbol
|
|
4139
|
-
* @param {object} [params] extra parameters specific to the
|
|
4139
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
4140
4140
|
* @param {bool} [params.hedged] set to true if hedged position mode is enabled (by default long and short leverage are set to the same value)
|
|
4141
4141
|
* @param {float} [params.longLeverageRr] *hedged mode only* set the leverage for long positions
|
|
4142
4142
|
* @param {float} [params.shortLeverageRr] *hedged mode only* set the leverage for short positions
|
|
@@ -4186,7 +4186,7 @@ class phemex extends phemex$1 {
|
|
|
4186
4186
|
* @param {float} amount amount to transfer
|
|
4187
4187
|
* @param {string} fromAccount account to transfer from
|
|
4188
4188
|
* @param {string} toAccount account to transfer to
|
|
4189
|
-
* @param {object} [params] extra parameters specific to the
|
|
4189
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
4190
4190
|
* @param {string} [params.bizType] for transferring between main and sub-acounts either 'SPOT' or 'PERPETUAL' default is 'SPOT'
|
|
4191
4191
|
* @returns {object} a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
|
|
4192
4192
|
*/
|
|
@@ -4272,7 +4272,7 @@ class phemex extends phemex$1 {
|
|
|
4272
4272
|
* @param {string} code unified currency code of the currency transferred
|
|
4273
4273
|
* @param {int} [since] the earliest time in ms to fetch transfers for
|
|
4274
4274
|
* @param {int} [limit] the maximum number of transfers structures to retrieve
|
|
4275
|
-
* @param {object} [params] extra parameters specific to the
|
|
4275
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
4276
4276
|
* @returns {object[]} a list of [transfer structures]{@link https://docs.ccxt.com/#/?id=transfer-structure}
|
|
4277
4277
|
*/
|
|
4278
4278
|
await this.loadMarkets();
|
|
@@ -4388,7 +4388,7 @@ class phemex extends phemex$1 {
|
|
|
4388
4388
|
* @param {string} symbol unified symbol of the market to fetch the funding rate history for
|
|
4389
4389
|
* @param {int} [since] timestamp in ms of the earliest funding rate to fetch
|
|
4390
4390
|
* @param {int} [limit] the maximum amount of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure} to fetch
|
|
4391
|
-
* @param {object} [params] extra parameters specific to the
|
|
4391
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
4392
4392
|
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
|
4393
4393
|
* @param {int} [params.until] timestamp in ms of the latest funding rate
|
|
4394
4394
|
* @returns {object[]} a list of [funding rate structures]{@link https://docs.ccxt.com/#/?id=funding-rate-history-structure}
|
package/dist/cjs/src/poloniex.js
CHANGED
|
@@ -410,7 +410,7 @@ class poloniex extends poloniex$1 {
|
|
|
410
410
|
* @param {string} timeframe the length of time each candle represents
|
|
411
411
|
* @param {int} [since] timestamp in ms of the earliest candle to fetch
|
|
412
412
|
* @param {int} [limit] the maximum amount of candles to fetch
|
|
413
|
-
* @param {object} [params] extra parameters specific to the
|
|
413
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
414
414
|
* @param {int} [params.until] timestamp in ms
|
|
415
415
|
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
|
416
416
|
* @returns {int[][]} A list of candles ordered as timestamp, open, high, low, close, volume
|
|
@@ -471,7 +471,7 @@ class poloniex extends poloniex$1 {
|
|
|
471
471
|
* @name poloniex#fetchMarkets
|
|
472
472
|
* @description retrieves data on all markets for poloniex
|
|
473
473
|
* @see https://docs.poloniex.com/#public-endpoints-reference-data-symbol-information
|
|
474
|
-
* @param {object} [params] extra parameters specific to the exchange
|
|
474
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
475
475
|
* @returns {object[]} an array of objects representing market data
|
|
476
476
|
*/
|
|
477
477
|
const markets = await this.publicGetMarkets(params);
|
|
@@ -562,7 +562,7 @@ class poloniex extends poloniex$1 {
|
|
|
562
562
|
* @name poloniex#fetchTime
|
|
563
563
|
* @description fetches the current integer timestamp in milliseconds from the exchange server
|
|
564
564
|
* @see https://docs.poloniex.com/#public-endpoints-reference-data-system-timestamp
|
|
565
|
-
* @param {object} [params] extra parameters specific to the
|
|
565
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
566
566
|
* @returns {int} the current integer timestamp in milliseconds from the exchange server
|
|
567
567
|
*/
|
|
568
568
|
const response = await this.publicGetTimestamp(params);
|
|
@@ -627,10 +627,10 @@ class poloniex extends poloniex$1 {
|
|
|
627
627
|
/**
|
|
628
628
|
* @method
|
|
629
629
|
* @name poloniex#fetchTickers
|
|
630
|
-
* @description fetches price tickers for multiple markets, statistical
|
|
630
|
+
* @description fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
|
|
631
631
|
* @see https://docs.poloniex.com/#public-endpoints-market-data-ticker
|
|
632
632
|
* @param {string[]|undefined} symbols unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
|
|
633
|
-
* @param {object} [params] extra parameters specific to the
|
|
633
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
634
634
|
* @returns {object} a dictionary of [ticker structures]{@link https://docs.ccxt.com/#/?id=ticker-structure}
|
|
635
635
|
*/
|
|
636
636
|
await this.loadMarkets();
|
|
@@ -668,7 +668,7 @@ class poloniex extends poloniex$1 {
|
|
|
668
668
|
* @name poloniex#fetchCurrencies
|
|
669
669
|
* @description fetches all available currencies on an exchange
|
|
670
670
|
* @see https://docs.poloniex.com/#public-endpoints-reference-data-currency-information
|
|
671
|
-
* @param {object} [params] extra parameters specific to the
|
|
671
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
672
672
|
* @returns {object} an associative dictionary of currencies
|
|
673
673
|
*/
|
|
674
674
|
const response = await this.publicGetCurrencies(this.extend(params, { 'includeMultiChainCurrencies': true }));
|
|
@@ -802,7 +802,7 @@ class poloniex extends poloniex$1 {
|
|
|
802
802
|
* @description fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
|
|
803
803
|
* @see https://docs.poloniex.com/#public-endpoints-market-data-ticker
|
|
804
804
|
* @param {string} symbol unified symbol of the market to fetch the ticker for
|
|
805
|
-
* @param {object} [params] extra parameters specific to the
|
|
805
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
806
806
|
* @returns {object} a [ticker structure]{@link https://docs.ccxt.com/#/?id=ticker-structure}
|
|
807
807
|
*/
|
|
808
808
|
await this.loadMarkets();
|
|
@@ -935,7 +935,7 @@ class poloniex extends poloniex$1 {
|
|
|
935
935
|
* @param {string} symbol unified symbol of the market to fetch trades for
|
|
936
936
|
* @param {int} [since] timestamp in ms of the earliest trade to fetch
|
|
937
937
|
* @param {int} [limit] the maximum amount of trades to fetch
|
|
938
|
-
* @param {object} [params] extra parameters specific to the
|
|
938
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
939
939
|
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=public-trades}
|
|
940
940
|
*/
|
|
941
941
|
await this.loadMarkets();
|
|
@@ -971,7 +971,7 @@ class poloniex extends poloniex$1 {
|
|
|
971
971
|
* @param {string} symbol unified market symbol
|
|
972
972
|
* @param {int} [since] the earliest time in ms to fetch trades for
|
|
973
973
|
* @param {int} [limit] the maximum number of trades structures to retrieve
|
|
974
|
-
* @param {object} [params] extra parameters specific to the
|
|
974
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
975
975
|
* @param {int} [params.until] the latest time in ms to fetch entries for
|
|
976
976
|
* @param {boolean} [params.paginate] default false, when true will automatically paginate by calling this endpoint multiple times. See in the docs all the [availble parameters](https://github.com/ccxt/ccxt/wiki/Manual#pagination-params)
|
|
977
977
|
* @returns {Trade[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
|
|
@@ -1183,7 +1183,7 @@ class poloniex extends poloniex$1 {
|
|
|
1183
1183
|
* @param {string} symbol unified market symbol
|
|
1184
1184
|
* @param {int} [since] the earliest time in ms to fetch open orders for
|
|
1185
1185
|
* @param {int} [limit] the maximum number of open orders structures to retrieve
|
|
1186
|
-
* @param {object} [params] extra parameters specific to the
|
|
1186
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1187
1187
|
* @param {boolean} [params.stop] set true to fetch trigger orders instead of regular orders
|
|
1188
1188
|
* @returns {Order[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
1189
1189
|
*/
|
|
@@ -1244,7 +1244,7 @@ class poloniex extends poloniex$1 {
|
|
|
1244
1244
|
* @param {string} side 'buy' or 'sell'
|
|
1245
1245
|
* @param {float} amount how much of currency you want to trade in units of base currency
|
|
1246
1246
|
* @param {float} [price] the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders
|
|
1247
|
-
* @param {object} [params] extra parameters specific to the
|
|
1247
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1248
1248
|
* @param {float} [params.triggerPrice] *spot only* The price at which a trigger order is triggered at
|
|
1249
1249
|
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
1250
1250
|
*/
|
|
@@ -1328,7 +1328,7 @@ class poloniex extends poloniex$1 {
|
|
|
1328
1328
|
* @param {string} side 'buy' or 'sell'
|
|
1329
1329
|
* @param {float} [amount] how much of the currency you want to trade in units of the base currency
|
|
1330
1330
|
* @param {float} [price] the price at which the order is to be fullfilled, in units of the quote currency, ignored in market orders
|
|
1331
|
-
* @param {object} [params] extra parameters specific to the
|
|
1331
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1332
1332
|
* @param {float} [params.triggerPrice] The price at which a trigger order is triggered at
|
|
1333
1333
|
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
1334
1334
|
*/
|
|
@@ -1370,7 +1370,7 @@ class poloniex extends poloniex$1 {
|
|
|
1370
1370
|
// @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-order-by-id // trigger orders
|
|
1371
1371
|
// @param {string} id order id
|
|
1372
1372
|
// @param {string} symbol unified symbol of the market the order was made in
|
|
1373
|
-
// @param {object} [params] extra parameters specific to the
|
|
1373
|
+
// @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1374
1374
|
// @param {boolean} [params.trigger] true if canceling a trigger order
|
|
1375
1375
|
// @returns {object} An [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
1376
1376
|
//
|
|
@@ -1409,7 +1409,7 @@ class poloniex extends poloniex$1 {
|
|
|
1409
1409
|
* @see https://docs.poloniex.com/#authenticated-endpoints-orders-cancel-all-orders
|
|
1410
1410
|
* @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-cancel-all-orders // trigger orders
|
|
1411
1411
|
* @param {string} symbol unified market symbol, only orders in the market of this symbol are cancelled when symbol is not undefined
|
|
1412
|
-
* @param {object} [params] extra parameters specific to the
|
|
1412
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1413
1413
|
* @param {boolean} [params.trigger] true if canceling trigger orders
|
|
1414
1414
|
* @returns {object[]} a list of [order structures]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
1415
1415
|
*/
|
|
@@ -1462,7 +1462,7 @@ class poloniex extends poloniex$1 {
|
|
|
1462
1462
|
* @see https://docs.poloniex.com/#authenticated-endpoints-smart-orders-open-orders // trigger orders
|
|
1463
1463
|
* @param {string} id order id
|
|
1464
1464
|
* @param {string} symbol unified market symbol, default is undefined
|
|
1465
|
-
* @param {object} [params] extra parameters specific to the
|
|
1465
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1466
1466
|
* @param {boolean} [params.trigger] true if fetching a trigger order
|
|
1467
1467
|
* @returns {object} an [order structure]{@link https://docs.ccxt.com/#/?id=order-structure}
|
|
1468
1468
|
*/
|
|
@@ -1522,7 +1522,7 @@ class poloniex extends poloniex$1 {
|
|
|
1522
1522
|
* @param {string} symbol unified market symbol
|
|
1523
1523
|
* @param {int} [since] the earliest time in ms to fetch trades for
|
|
1524
1524
|
* @param {int} [limit] the maximum number of trades to retrieve
|
|
1525
|
-
* @param {object} [params] extra parameters specific to the
|
|
1525
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1526
1526
|
* @returns {object[]} a list of [trade structures]{@link https://docs.ccxt.com/#/?id=trade-structure}
|
|
1527
1527
|
*/
|
|
1528
1528
|
await this.loadMarkets();
|
|
@@ -1580,7 +1580,7 @@ class poloniex extends poloniex$1 {
|
|
|
1580
1580
|
* @name poloniex#fetchBalance
|
|
1581
1581
|
* @description query for balance and get the amount of funds available for trading or funds locked in orders
|
|
1582
1582
|
* @see https://docs.poloniex.com/#authenticated-endpoints-accounts-all-account-balances
|
|
1583
|
-
* @param {object} [params] extra parameters specific to the
|
|
1583
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1584
1584
|
* @returns {object} a [balance structure]{@link https://docs.ccxt.com/#/?id=balance-structure}
|
|
1585
1585
|
*/
|
|
1586
1586
|
await this.loadMarkets();
|
|
@@ -1612,7 +1612,7 @@ class poloniex extends poloniex$1 {
|
|
|
1612
1612
|
* @name poloniex#fetchTradingFees
|
|
1613
1613
|
* @description fetch the trading fees for multiple markets
|
|
1614
1614
|
* @see https://docs.poloniex.com/#authenticated-endpoints-accounts-fee-info
|
|
1615
|
-
* @param {object} [params] extra parameters specific to the
|
|
1615
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1616
1616
|
* @returns {object} a dictionary of [fee structures]{@link https://docs.ccxt.com/#/?id=fee-structure} indexed by market symbols
|
|
1617
1617
|
*/
|
|
1618
1618
|
await this.loadMarkets();
|
|
@@ -1647,7 +1647,7 @@ class poloniex extends poloniex$1 {
|
|
|
1647
1647
|
* @see https://docs.poloniex.com/#public-endpoints-market-data-order-book
|
|
1648
1648
|
* @param {string} symbol unified symbol of the market to fetch the order book for
|
|
1649
1649
|
* @param {int} [limit] the maximum amount of order book entries to return
|
|
1650
|
-
* @param {object} [params] extra parameters specific to the
|
|
1650
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1651
1651
|
* @returns {object} A dictionary of [order book structures]{@link https://docs.ccxt.com/#/?id=order-book-structure} indexed by market symbols
|
|
1652
1652
|
*/
|
|
1653
1653
|
await this.loadMarkets();
|
|
@@ -1703,7 +1703,7 @@ class poloniex extends poloniex$1 {
|
|
|
1703
1703
|
* @description create a currency deposit address
|
|
1704
1704
|
* @see https://docs.poloniex.com/#authenticated-endpoints-wallets-deposit-addresses
|
|
1705
1705
|
* @param {string} code unified currency code of the currency for the deposit address
|
|
1706
|
-
* @param {object} [params] extra parameters specific to the
|
|
1706
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1707
1707
|
* @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
|
|
1708
1708
|
*/
|
|
1709
1709
|
await this.loadMarkets();
|
|
@@ -1754,7 +1754,7 @@ class poloniex extends poloniex$1 {
|
|
|
1754
1754
|
* @description fetch the deposit address for a currency associated with this account
|
|
1755
1755
|
* @see https://docs.poloniex.com/#authenticated-endpoints-wallets-deposit-addresses
|
|
1756
1756
|
* @param {string} code unified currency code
|
|
1757
|
-
* @param {object} [params] extra parameters specific to the
|
|
1757
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1758
1758
|
* @returns {object} an [address structure]{@link https://docs.ccxt.com/#/?id=address-structure}
|
|
1759
1759
|
*/
|
|
1760
1760
|
await this.loadMarkets();
|
|
@@ -1808,7 +1808,7 @@ class poloniex extends poloniex$1 {
|
|
|
1808
1808
|
* @param {float} amount amount to transfer
|
|
1809
1809
|
* @param {string} fromAccount account to transfer from
|
|
1810
1810
|
* @param {string} toAccount account to transfer to
|
|
1811
|
-
* @param {object} [params] extra parameters specific to the
|
|
1811
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1812
1812
|
* @returns {object} a [transfer structure]{@link https://docs.ccxt.com/#/?id=transfer-structure}
|
|
1813
1813
|
*/
|
|
1814
1814
|
await this.loadMarkets();
|
|
@@ -1859,7 +1859,7 @@ class poloniex extends poloniex$1 {
|
|
|
1859
1859
|
* @param {float} amount the amount to withdraw
|
|
1860
1860
|
* @param {string} address the address to withdraw to
|
|
1861
1861
|
* @param {string} tag
|
|
1862
|
-
* @param {object} [params] extra parameters specific to the
|
|
1862
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1863
1863
|
* @returns {object} a [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
|
1864
1864
|
*/
|
|
1865
1865
|
[tag, params] = this.handleWithdrawTagAndParams(tag, params);
|
|
@@ -1983,7 +1983,7 @@ class poloniex extends poloniex$1 {
|
|
|
1983
1983
|
* @param {string} [code] unified currency code for the currency of the deposit/withdrawals, default is undefined
|
|
1984
1984
|
* @param {int} [since] timestamp in ms of the earliest deposit/withdrawal, default is undefined
|
|
1985
1985
|
* @param {int} [limit] max number of deposit/withdrawals to return, default is undefined
|
|
1986
|
-
* @param {object} [params] extra parameters specific to the
|
|
1986
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
1987
1987
|
* @returns {object} a list of [transaction structure]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
|
1988
1988
|
*/
|
|
1989
1989
|
await this.loadMarkets();
|
|
@@ -2008,7 +2008,7 @@ class poloniex extends poloniex$1 {
|
|
|
2008
2008
|
* @param {string} code unified currency code
|
|
2009
2009
|
* @param {int} [since] the earliest time in ms to fetch withdrawals for
|
|
2010
2010
|
* @param {int} [limit] the maximum number of withdrawals structures to retrieve
|
|
2011
|
-
* @param {object} [params] extra parameters specific to the
|
|
2011
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2012
2012
|
* @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
|
2013
2013
|
*/
|
|
2014
2014
|
const response = await this.fetchTransactionsHelper(code, since, limit, params);
|
|
@@ -2027,7 +2027,7 @@ class poloniex extends poloniex$1 {
|
|
|
2027
2027
|
* @description fetch deposit and withdraw fees
|
|
2028
2028
|
* @see https://docs.poloniex.com/#public-endpoints-reference-data-currency-information
|
|
2029
2029
|
* @param {string[]|undefined} codes list of unified currency codes
|
|
2030
|
-
* @param {object} [params] extra parameters specific to the
|
|
2030
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2031
2031
|
* @returns {object[]} a list of [fees structures]{@link https://docs.ccxt.com/#/?id=fee-structure}
|
|
2032
2032
|
*/
|
|
2033
2033
|
await this.loadMarkets();
|
|
@@ -2154,7 +2154,7 @@ class poloniex extends poloniex$1 {
|
|
|
2154
2154
|
* @param {string} code unified currency code
|
|
2155
2155
|
* @param {int} [since] the earliest time in ms to fetch deposits for
|
|
2156
2156
|
* @param {int} [limit] the maximum number of deposits structures to retrieve
|
|
2157
|
-
* @param {object} [params] extra parameters specific to the
|
|
2157
|
+
* @param {object} [params] extra parameters specific to the exchange API endpoint
|
|
2158
2158
|
* @returns {object[]} a list of [transaction structures]{@link https://docs.ccxt.com/#/?id=transaction-structure}
|
|
2159
2159
|
*/
|
|
2160
2160
|
const response = await this.fetchTransactionsHelper(code, since, limit, params);
|