ccxt 4.1.19__py2.py3-none-any.whl → 4.1.22__py2.py3-none-any.whl

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.
Files changed (179) hide show
  1. ccxt/__init__.py +1 -1
  2. ccxt/abstract/okcoin.py +70 -206
  3. ccxt/ace.py +12 -12
  4. ccxt/ascendex.py +5 -5
  5. ccxt/async_support/__init__.py +1 -1
  6. ccxt/async_support/ace.py +12 -12
  7. ccxt/async_support/ascendex.py +5 -5
  8. ccxt/async_support/base/exchange.py +1 -1
  9. ccxt/async_support/bigone.py +2 -2
  10. ccxt/async_support/binance.py +184 -184
  11. ccxt/async_support/bingx.py +48 -48
  12. ccxt/async_support/bitbank.py +14 -14
  13. ccxt/async_support/bitbns.py +7 -7
  14. ccxt/async_support/bitfinex.py +2 -2
  15. ccxt/async_support/bitfinex2.py +35 -35
  16. ccxt/async_support/bitflyer.py +17 -17
  17. ccxt/async_support/bitforex.py +9 -9
  18. ccxt/async_support/bitget.py +433 -215
  19. ccxt/async_support/bitmart.py +39 -39
  20. ccxt/async_support/bitmex.py +7 -7
  21. ccxt/async_support/bitopro.py +1 -1
  22. ccxt/async_support/bitpanda.py +1 -1
  23. ccxt/async_support/bitrue.py +2 -2
  24. ccxt/async_support/bitso.py +2 -2
  25. ccxt/async_support/bitstamp.py +3 -3
  26. ccxt/async_support/bitvavo.py +2 -2
  27. ccxt/async_support/bl3p.py +1 -1
  28. ccxt/async_support/btcalpha.py +7 -7
  29. ccxt/async_support/btcturk.py +1 -1
  30. ccxt/async_support/bybit.py +58 -58
  31. ccxt/async_support/cex.py +1 -1
  32. ccxt/async_support/coinbase.py +13 -13
  33. ccxt/async_support/coinbasepro.py +15 -15
  34. ccxt/async_support/coinex.py +19 -19
  35. ccxt/async_support/coinone.py +2 -2
  36. ccxt/async_support/coinsph.py +4 -4
  37. ccxt/async_support/coinspot.py +2 -2
  38. ccxt/async_support/cryptocom.py +28 -28
  39. ccxt/async_support/currencycom.py +1 -1
  40. ccxt/async_support/delta.py +26 -26
  41. ccxt/async_support/deribit.py +9 -9
  42. ccxt/async_support/digifinex.py +38 -38
  43. ccxt/async_support/exmo.py +18 -18
  44. ccxt/async_support/gate.py +59 -59
  45. ccxt/async_support/gemini.py +4 -4
  46. ccxt/async_support/hitbtc.py +6 -6
  47. ccxt/async_support/hollaex.py +2 -2
  48. ccxt/async_support/huobi.py +70 -70
  49. ccxt/async_support/indodax.py +1 -1
  50. ccxt/async_support/kraken.py +33 -33
  51. ccxt/async_support/krakenfutures.py +6 -5
  52. ccxt/async_support/kucoin.py +74 -74
  53. ccxt/async_support/kucoinfutures.py +8 -8
  54. ccxt/async_support/latoken.py +14 -14
  55. ccxt/async_support/lbank2.py +33 -33
  56. ccxt/async_support/mexc.py +22 -22
  57. ccxt/async_support/ndax.py +1 -1
  58. ccxt/async_support/novadax.py +22 -22
  59. ccxt/async_support/oceanex.py +18 -18
  60. ccxt/async_support/okcoin.py +1950 -2758
  61. ccxt/async_support/okx.py +73 -73
  62. ccxt/async_support/paymium.py +11 -11
  63. ccxt/async_support/phemex.py +26 -26
  64. ccxt/async_support/poloniex.py +30 -30
  65. ccxt/async_support/poloniexfutures.py +25 -25
  66. ccxt/async_support/probit.py +21 -21
  67. ccxt/async_support/tokocrypto.py +22 -22
  68. ccxt/async_support/upbit.py +21 -21
  69. ccxt/async_support/wavesexchange.py +2 -2
  70. ccxt/async_support/wazirx.py +14 -14
  71. ccxt/async_support/whitebit.py +6 -6
  72. ccxt/async_support/woo.py +21 -21
  73. ccxt/async_support/yobit.py +16 -16
  74. ccxt/async_support/zaif.py +10 -10
  75. ccxt/async_support/zonda.py +15 -15
  76. ccxt/base/exchange.py +2 -1
  77. ccxt/bigone.py +2 -2
  78. ccxt/binance.py +184 -184
  79. ccxt/bingx.py +48 -48
  80. ccxt/bitbank.py +14 -14
  81. ccxt/bitbns.py +7 -7
  82. ccxt/bitfinex.py +2 -2
  83. ccxt/bitfinex2.py +35 -35
  84. ccxt/bitflyer.py +17 -17
  85. ccxt/bitforex.py +9 -9
  86. ccxt/bitget.py +433 -215
  87. ccxt/bitmart.py +39 -39
  88. ccxt/bitmex.py +7 -7
  89. ccxt/bitopro.py +1 -1
  90. ccxt/bitpanda.py +1 -1
  91. ccxt/bitrue.py +2 -2
  92. ccxt/bitso.py +2 -2
  93. ccxt/bitstamp.py +3 -3
  94. ccxt/bitvavo.py +2 -2
  95. ccxt/bl3p.py +1 -1
  96. ccxt/btcalpha.py +7 -7
  97. ccxt/btcturk.py +1 -1
  98. ccxt/bybit.py +58 -58
  99. ccxt/cex.py +1 -1
  100. ccxt/coinbase.py +13 -13
  101. ccxt/coinbasepro.py +15 -15
  102. ccxt/coinex.py +19 -19
  103. ccxt/coinone.py +2 -2
  104. ccxt/coinsph.py +4 -4
  105. ccxt/coinspot.py +2 -2
  106. ccxt/cryptocom.py +28 -28
  107. ccxt/currencycom.py +1 -1
  108. ccxt/delta.py +26 -26
  109. ccxt/deribit.py +9 -9
  110. ccxt/digifinex.py +38 -38
  111. ccxt/exmo.py +18 -18
  112. ccxt/gate.py +59 -59
  113. ccxt/gemini.py +4 -4
  114. ccxt/hitbtc.py +6 -6
  115. ccxt/hollaex.py +2 -2
  116. ccxt/huobi.py +70 -70
  117. ccxt/indodax.py +1 -1
  118. ccxt/kraken.py +33 -33
  119. ccxt/krakenfutures.py +6 -5
  120. ccxt/kucoin.py +74 -74
  121. ccxt/kucoinfutures.py +8 -8
  122. ccxt/latoken.py +14 -14
  123. ccxt/lbank2.py +33 -33
  124. ccxt/mexc.py +22 -22
  125. ccxt/ndax.py +1 -1
  126. ccxt/novadax.py +22 -22
  127. ccxt/oceanex.py +18 -18
  128. ccxt/okcoin.py +1950 -2758
  129. ccxt/okx.py +73 -73
  130. ccxt/paymium.py +11 -11
  131. ccxt/phemex.py +26 -26
  132. ccxt/poloniex.py +30 -30
  133. ccxt/poloniexfutures.py +25 -25
  134. ccxt/pro/__init__.py +1 -1
  135. ccxt/pro/ascendex.py +1 -1
  136. ccxt/pro/binance.py +9 -9
  137. ccxt/pro/bingx.py +12 -12
  138. ccxt/pro/bitget.py +2 -2
  139. ccxt/pro/bitpanda.py +7 -7
  140. ccxt/pro/bitrue.py +2 -2
  141. ccxt/pro/blockchaincom.py +6 -6
  142. ccxt/pro/bybit.py +15 -15
  143. ccxt/pro/cex.py +8 -8
  144. ccxt/pro/coinbase.py +6 -6
  145. ccxt/pro/coinbasepro.py +1 -1
  146. ccxt/pro/coinex.py +8 -8
  147. ccxt/pro/cryptocom.py +12 -12
  148. ccxt/pro/deribit.py +7 -7
  149. ccxt/pro/gemini.py +4 -4
  150. ccxt/pro/hitbtc.py +17 -17
  151. ccxt/pro/huobi.py +3 -3
  152. ccxt/pro/kraken.py +6 -6
  153. ccxt/pro/krakenfutures.py +10 -10
  154. ccxt/pro/kucoin.py +85 -42
  155. ccxt/pro/kucoinfutures.py +5 -5
  156. ccxt/pro/luno.py +1 -1
  157. ccxt/pro/mexc.py +7 -7
  158. ccxt/pro/okx.py +16 -15
  159. ccxt/pro/phemex.py +15 -15
  160. ccxt/pro/poloniex.py +9 -9
  161. ccxt/pro/poloniexfutures.py +5 -5
  162. ccxt/pro/probit.py +5 -5
  163. ccxt/pro/wazirx.py +5 -5
  164. ccxt/pro/woo.py +1 -1
  165. ccxt/probit.py +21 -21
  166. ccxt/test/base/test_shared_methods.py +1 -1
  167. ccxt/tokocrypto.py +22 -22
  168. ccxt/upbit.py +21 -21
  169. ccxt/wavesexchange.py +2 -2
  170. ccxt/wazirx.py +14 -14
  171. ccxt/whitebit.py +6 -6
  172. ccxt/woo.py +21 -21
  173. ccxt/yobit.py +16 -16
  174. ccxt/zaif.py +10 -10
  175. ccxt/zonda.py +15 -15
  176. {ccxt-4.1.19.dist-info → ccxt-4.1.22.dist-info}/METADATA +5 -9
  177. {ccxt-4.1.19.dist-info → ccxt-4.1.22.dist-info}/RECORD +179 -179
  178. {ccxt-4.1.19.dist-info → ccxt-4.1.22.dist-info}/WHEEL +0 -0
  179. {ccxt-4.1.19.dist-info → ccxt-4.1.22.dist-info}/top_level.txt +0 -0
ccxt/bitfinex2.py CHANGED
@@ -450,7 +450,7 @@ class bitfinex2(Exchange, ImplicitAPI):
450
450
  def fetch_status(self, params={}):
451
451
  """
452
452
  the latest known information on the availability of the exchange API
453
- see https://docs.bitfinex.com/reference/rest-public-platform-status
453
+ :see: https://docs.bitfinex.com/reference/rest-public-platform-status
454
454
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
455
455
  :returns dict: a `status structure <https://github.com/ccxt/ccxt/wiki/Manual#exchange-status-structure>`
456
456
  """
@@ -471,7 +471,7 @@ class bitfinex2(Exchange, ImplicitAPI):
471
471
  def fetch_markets(self, params={}):
472
472
  """
473
473
  retrieves data on all markets for bitfinex2
474
- see https://docs.bitfinex.com/reference/rest-public-conf
474
+ :see: https://docs.bitfinex.com/reference/rest-public-conf
475
475
  :param dict [params]: extra parameters specific to the exchange api endpoint
476
476
  :returns dict[]: an array of objects representing market data
477
477
  """
@@ -593,7 +593,7 @@ class bitfinex2(Exchange, ImplicitAPI):
593
593
  def fetch_currencies(self, params={}):
594
594
  """
595
595
  fetches all available currencies on an exchange
596
- see https://docs.bitfinex.com/reference/rest-public-conf
596
+ :see: https://docs.bitfinex.com/reference/rest-public-conf
597
597
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
598
598
  :returns dict: an associative dictionary of currencies
599
599
  """
@@ -797,7 +797,7 @@ class bitfinex2(Exchange, ImplicitAPI):
797
797
  def fetch_balance(self, params={}):
798
798
  """
799
799
  query for balance and get the amount of funds available for trading or funds locked in orders
800
- see https://docs.bitfinex.com/reference/rest-auth-wallets
800
+ :see: https://docs.bitfinex.com/reference/rest-auth-wallets
801
801
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
802
802
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
803
803
  """
@@ -833,7 +833,7 @@ class bitfinex2(Exchange, ImplicitAPI):
833
833
  def transfer(self, code: str, amount, fromAccount, toAccount, params={}):
834
834
  """
835
835
  transfer currency internally between wallets on the same account
836
- see https://docs.bitfinex.com/reference/rest-auth-transfer
836
+ :see: https://docs.bitfinex.com/reference/rest-auth-transfer
837
837
  :param str code: unified currency code
838
838
  :param float amount: amount to transfer
839
839
  :param str fromAccount: account to transfer from
@@ -970,7 +970,7 @@ class bitfinex2(Exchange, ImplicitAPI):
970
970
  def fetch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
971
971
  """
972
972
  fetches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
973
- see https://docs.bitfinex.com/reference/rest-public-book
973
+ :see: https://docs.bitfinex.com/reference/rest-public-book
974
974
  :param str symbol: unified symbol of the market to fetch the order book for
975
975
  :param int [limit]: the maximum amount of order book entries to return
976
976
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
@@ -1079,7 +1079,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1079
1079
  def fetch_tickers(self, symbols: Optional[List[str]] = None, params={}):
1080
1080
  """
1081
1081
  fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
1082
- see https://docs.bitfinex.com/reference/rest-public-tickers
1082
+ :see: https://docs.bitfinex.com/reference/rest-public-tickers
1083
1083
  :param str[]|None symbols: unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
1084
1084
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
1085
1085
  :returns dict: a dictionary of `ticker structures <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -1144,7 +1144,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1144
1144
  def fetch_ticker(self, symbol: str, params={}):
1145
1145
  """
1146
1146
  fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
1147
- see https://docs.bitfinex.com/reference/rest-public-ticker
1147
+ :see: https://docs.bitfinex.com/reference/rest-public-ticker
1148
1148
  :param str symbol: unified symbol of the market to fetch the ticker for
1149
1149
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
1150
1150
  :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -1240,7 +1240,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1240
1240
  def fetch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
1241
1241
  """
1242
1242
  get the list of most recent trades for a particular symbol
1243
- see https://docs.bitfinex.com/reference/rest-public-trades
1243
+ :see: https://docs.bitfinex.com/reference/rest-public-trades
1244
1244
  :param str symbol: unified symbol of the market to fetch trades for
1245
1245
  :param int [since]: timestamp in ms of the earliest trade to fetch
1246
1246
  :param int [limit]: the maximum amount of trades to fetch
@@ -1283,7 +1283,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1283
1283
  def fetch_ohlcv(self, symbol: str, timeframe='1m', since: Optional[int] = None, limit=100, params={}):
1284
1284
  """
1285
1285
  fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
1286
- see https://docs.bitfinex.com/reference/rest-public-candles
1286
+ :see: https://docs.bitfinex.com/reference/rest-public-candles
1287
1287
  :param str symbol: unified symbol of the market to fetch OHLCV data for
1288
1288
  :param str timeframe: the length of time each candle represents
1289
1289
  :param int [since]: timestamp in ms of the earliest candle to fetch
@@ -1443,7 +1443,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1443
1443
  def create_order(self, symbol: str, type: OrderType, side: OrderSide, amount, price=None, params={}):
1444
1444
  """
1445
1445
  Create an order on the exchange
1446
- see https://docs.bitfinex.com/reference/rest-auth-submit-order
1446
+ :see: https://docs.bitfinex.com/reference/rest-auth-submit-order
1447
1447
  :param str symbol: Unified CCXT market symbol
1448
1448
  :param str type: 'limit' or 'market'
1449
1449
  :param str side: 'buy' or 'sell'
@@ -1592,7 +1592,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1592
1592
  def cancel_all_orders(self, symbol: Optional[str] = None, params={}):
1593
1593
  """
1594
1594
  cancel all open orders
1595
- see https://docs.bitfinex.com/reference/rest-auth-cancel-orders-multiple
1595
+ :see: https://docs.bitfinex.com/reference/rest-auth-cancel-orders-multiple
1596
1596
  :param str symbol: unified market symbol, only orders in the market of self symbol are cancelled when symbol is not None
1597
1597
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
1598
1598
  :returns dict[]: a list of `order structures <https://github.com/ccxt/ccxt/wiki/Manual#order-structure>`
@@ -1607,7 +1607,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1607
1607
  def cancel_order(self, id: str, symbol: Optional[str] = None, params={}):
1608
1608
  """
1609
1609
  cancels an open order
1610
- see https://docs.bitfinex.com/reference/rest-auth-cancel-order
1610
+ :see: https://docs.bitfinex.com/reference/rest-auth-cancel-order
1611
1611
  :param str id: order id
1612
1612
  :param str symbol: Not used by bitfinex2 cancelOrder()
1613
1613
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
@@ -1635,8 +1635,8 @@ class bitfinex2(Exchange, ImplicitAPI):
1635
1635
  def fetch_open_order(self, id: str, symbol: Optional[str] = None, params={}):
1636
1636
  """
1637
1637
  fetch an open order by it's id
1638
- see https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
1639
- see https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol
1638
+ :see: https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
1639
+ :see: https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol
1640
1640
  :param str id: order id
1641
1641
  :param str symbol: unified market symbol, default is None
1642
1642
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
@@ -1654,8 +1654,8 @@ class bitfinex2(Exchange, ImplicitAPI):
1654
1654
  def fetch_closed_order(self, id: str, symbol: Optional[str] = None, params={}):
1655
1655
  """
1656
1656
  fetch an open order by it's id
1657
- see https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
1658
- see https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol
1657
+ :see: https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
1658
+ :see: https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol
1659
1659
  :param str id: order id
1660
1660
  :param str symbol: unified market symbol, default is None
1661
1661
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
@@ -1673,8 +1673,8 @@ class bitfinex2(Exchange, ImplicitAPI):
1673
1673
  def fetch_open_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
1674
1674
  """
1675
1675
  fetch all unfilled currently open orders
1676
- see https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
1677
- see https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol
1676
+ :see: https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
1677
+ :see: https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol
1678
1678
  :param str symbol: unified market symbol
1679
1679
  :param int [since]: the earliest time in ms to fetch open orders for
1680
1680
  :param int [limit]: the maximum number of open orders structures to retrieve
@@ -1734,8 +1734,8 @@ class bitfinex2(Exchange, ImplicitAPI):
1734
1734
  def fetch_closed_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
1735
1735
  """
1736
1736
  fetches information on multiple closed orders made by the user
1737
- see https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
1738
- see https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol
1737
+ :see: https://docs.bitfinex.com/reference/rest-auth-retrieve-orders
1738
+ :see: https://docs.bitfinex.com/reference/rest-auth-retrieve-orders-by-symbol
1739
1739
  :param str symbol: unified market symbol of the market orders were made in
1740
1740
  :param int [since]: the earliest time in ms to fetch orders for
1741
1741
  :param int [limit]: the maximum number of orde structures to retrieve
@@ -1807,7 +1807,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1807
1807
  def fetch_order_trades(self, id: str, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
1808
1808
  """
1809
1809
  fetch all the trades made from a single order
1810
- see https://docs.bitfinex.com/reference/rest-auth-order-trades
1810
+ :see: https://docs.bitfinex.com/reference/rest-auth-order-trades
1811
1811
  :param str id: order id
1812
1812
  :param str symbol: unified market symbol
1813
1813
  :param int [since]: the earliest time in ms to fetch trades for
@@ -1831,8 +1831,8 @@ class bitfinex2(Exchange, ImplicitAPI):
1831
1831
  def fetch_my_trades(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
1832
1832
  """
1833
1833
  fetch all trades made by the user
1834
- see https://docs.bitfinex.com/reference/rest-auth-trades
1835
- see https://docs.bitfinex.com/reference/rest-auth-trades-by-symbol
1834
+ :see: https://docs.bitfinex.com/reference/rest-auth-trades
1835
+ :see: https://docs.bitfinex.com/reference/rest-auth-trades-by-symbol
1836
1836
  :param str symbol: unified market symbol
1837
1837
  :param int [since]: the earliest time in ms to fetch trades for
1838
1838
  :param int [limit]: the maximum number of trades structures to retrieve
@@ -1860,7 +1860,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1860
1860
  def create_deposit_address(self, code: str, params={}):
1861
1861
  """
1862
1862
  create a currency deposit address
1863
- see https://docs.bitfinex.com/reference/rest-auth-deposit-address
1863
+ :see: https://docs.bitfinex.com/reference/rest-auth-deposit-address
1864
1864
  :param str code: unified currency code of the currency for the deposit address
1865
1865
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
1866
1866
  :returns dict: an `address structure <https://github.com/ccxt/ccxt/wiki/Manual#address-structure>`
@@ -1874,7 +1874,7 @@ class bitfinex2(Exchange, ImplicitAPI):
1874
1874
  def fetch_deposit_address(self, code: str, params={}):
1875
1875
  """
1876
1876
  fetch the deposit address for a currency associated with self account
1877
- see https://docs.bitfinex.com/reference/rest-auth-deposit-address
1877
+ :see: https://docs.bitfinex.com/reference/rest-auth-deposit-address
1878
1878
  :param str code: unified currency code
1879
1879
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
1880
1880
  :returns dict: an `address structure <https://github.com/ccxt/ccxt/wiki/Manual#address-structure>`
@@ -2077,7 +2077,7 @@ class bitfinex2(Exchange, ImplicitAPI):
2077
2077
  def fetch_trading_fees(self, params={}):
2078
2078
  """
2079
2079
  fetch the trading fees for multiple markets
2080
- see https://docs.bitfinex.com/reference/rest-auth-summary
2080
+ :see: https://docs.bitfinex.com/reference/rest-auth-summary
2081
2081
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
2082
2082
  :returns dict: a dictionary of `fee structures <https://github.com/ccxt/ccxt/wiki/Manual#fee-structure>` indexed by market symbols
2083
2083
  """
@@ -2185,8 +2185,8 @@ class bitfinex2(Exchange, ImplicitAPI):
2185
2185
  def fetch_deposits_withdrawals(self, code: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
2186
2186
  """
2187
2187
  fetch history of deposits and withdrawals
2188
- see https://docs.bitfinex.com/reference/movement-info
2189
- see https://docs.bitfinex.com/reference/rest-auth-movements
2188
+ :see: https://docs.bitfinex.com/reference/movement-info
2189
+ :see: https://docs.bitfinex.com/reference/rest-auth-movements
2190
2190
  :param str [code]: unified currency code for the currency of the deposit/withdrawals, default is None
2191
2191
  :param int [since]: timestamp in ms of the earliest deposit/withdrawal, default is None
2192
2192
  :param int [limit]: max number of deposit/withdrawals to return, default is None
@@ -2240,7 +2240,7 @@ class bitfinex2(Exchange, ImplicitAPI):
2240
2240
  def withdraw(self, code: str, amount, address, tag=None, params={}):
2241
2241
  """
2242
2242
  make a withdrawal
2243
- see https://docs.bitfinex.com/reference/rest-auth-withdraw
2243
+ :see: https://docs.bitfinex.com/reference/rest-auth-withdraw
2244
2244
  :param str code: unified currency code
2245
2245
  :param float amount: the amount to withdraw
2246
2246
  :param str address: the address to withdraw to
@@ -2323,7 +2323,7 @@ class bitfinex2(Exchange, ImplicitAPI):
2323
2323
  def fetch_positions(self, symbols: Optional[List[str]] = None, params={}):
2324
2324
  """
2325
2325
  fetch all open positions
2326
- see https://docs.bitfinex.com/reference/rest-auth-positions
2326
+ :see: https://docs.bitfinex.com/reference/rest-auth-positions
2327
2327
  :param str[]|None symbols: list of unified market symbols
2328
2328
  :param dict [params]: extra parameters specific to the bitfinex2 api endpoint
2329
2329
  :returns dict[]: a list of `position structure <https://github.com/ccxt/ccxt/wiki/Manual#position-structure>`
@@ -2555,7 +2555,7 @@ class bitfinex2(Exchange, ImplicitAPI):
2555
2555
  def fetch_ledger(self, code: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
2556
2556
  """
2557
2557
  fetch the history of changes, actions done by the user or operations that altered balance of the user
2558
- see https://docs.bitfinex.com/reference/rest-auth-ledgers
2558
+ :see: https://docs.bitfinex.com/reference/rest-auth-ledgers
2559
2559
  :param str code: unified currency code, default is None
2560
2560
  :param int [since]: timestamp in ms of the earliest ledger entry, default is None
2561
2561
  :param int [limit]: max number of ledger entrys to return, default is None
@@ -2604,7 +2604,7 @@ class bitfinex2(Exchange, ImplicitAPI):
2604
2604
  def fetch_funding_rate(self, symbol: str, params={}):
2605
2605
  """
2606
2606
  fetch the current funding rate
2607
- see https://docs.bitfinex.com/reference/rest-public-derivatives-status
2607
+ :see: https://docs.bitfinex.com/reference/rest-public-derivatives-status
2608
2608
  :param str symbol: unified market symbol
2609
2609
  :param dict [params]: extra parameters specific to the bingx api endpoint
2610
2610
  :returns dict: a `funding rate structure <https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-structure>`
@@ -2614,7 +2614,7 @@ class bitfinex2(Exchange, ImplicitAPI):
2614
2614
  def fetch_funding_rates(self, symbols: Optional[List[str]] = None, params={}):
2615
2615
  """
2616
2616
  fetch the current funding rate
2617
- see https://docs.bitfinex.com/reference/rest-public-derivatives-status
2617
+ :see: https://docs.bitfinex.com/reference/rest-public-derivatives-status
2618
2618
  :param str[] symbols: list of unified market symbols
2619
2619
  :param dict [params]: extra parameters specific to the bingx api endpoint
2620
2620
  :returns dict: a `funding rate structure <https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-structure>`
@@ -2662,7 +2662,7 @@ class bitfinex2(Exchange, ImplicitAPI):
2662
2662
  def fetch_funding_rate_history(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
2663
2663
  """
2664
2664
  fetches historical funding rate prices
2665
- see https://docs.bitfinex.com/reference/rest-public-derivatives-status-history
2665
+ :see: https://docs.bitfinex.com/reference/rest-public-derivatives-status-history
2666
2666
  :param str symbol: unified market symbol
2667
2667
  :param dict [params]: extra parameters specific to the bingx api endpoint
2668
2668
  :param int [params.until]: timestamp in ms of the latest funding rate
ccxt/bitflyer.py CHANGED
@@ -151,7 +151,7 @@ class bitflyer(Exchange, ImplicitAPI):
151
151
  def fetch_markets(self, params={}):
152
152
  """
153
153
  retrieves data on all markets for bitflyer
154
- see https://lightning.bitflyer.com/docs?lang=en#market-list
154
+ :see: https://lightning.bitflyer.com/docs?lang=en#market-list
155
155
  :param dict [params]: extra parameters specific to the exchange api endpoint
156
156
  :returns dict[]: an array of objects representing market data
157
157
  """
@@ -309,7 +309,7 @@ class bitflyer(Exchange, ImplicitAPI):
309
309
  def fetch_balance(self, params={}):
310
310
  """
311
311
  query for balance and get the amount of funds available for trading or funds locked in orders
312
- see https://lightning.bitflyer.com/docs?lang=en#get-account-asset-balance
312
+ :see: https://lightning.bitflyer.com/docs?lang=en#get-account-asset-balance
313
313
  :param dict [params]: extra parameters specific to the bitflyer api endpoint
314
314
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
315
315
  """
@@ -339,7 +339,7 @@ class bitflyer(Exchange, ImplicitAPI):
339
339
  def fetch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
340
340
  """
341
341
  fetches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
342
- see https://lightning.bitflyer.com/docs?lang=en#order-book
342
+ :see: https://lightning.bitflyer.com/docs?lang=en#order-book
343
343
  :param str symbol: unified symbol of the market to fetch the order book for
344
344
  :param int [limit]: the maximum amount of order book entries to return
345
345
  :param dict [params]: extra parameters specific to the bitflyer api endpoint
@@ -383,7 +383,7 @@ class bitflyer(Exchange, ImplicitAPI):
383
383
  def fetch_ticker(self, symbol: str, params={}):
384
384
  """
385
385
  fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
386
- see https://lightning.bitflyer.com/docs?lang=en#ticker
386
+ :see: https://lightning.bitflyer.com/docs?lang=en#ticker
387
387
  :param str symbol: unified symbol of the market to fetch the ticker for
388
388
  :param dict [params]: extra parameters specific to the bitflyer api endpoint
389
389
  :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -458,7 +458,7 @@ class bitflyer(Exchange, ImplicitAPI):
458
458
  def fetch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
459
459
  """
460
460
  get the list of most recent trades for a particular symbol
461
- see https://lightning.bitflyer.com/docs?lang=en#list-executions
461
+ :see: https://lightning.bitflyer.com/docs?lang=en#list-executions
462
462
  :param str symbol: unified symbol of the market to fetch trades for
463
463
  :param int [since]: timestamp in ms of the earliest trade to fetch
464
464
  :param int [limit]: the maximum amount of trades to fetch
@@ -491,7 +491,7 @@ class bitflyer(Exchange, ImplicitAPI):
491
491
  def fetch_trading_fee(self, symbol: str, params={}):
492
492
  """
493
493
  fetch the trading fees for a market
494
- see https://lightning.bitflyer.com/docs?lang=en#get-trading-commission
494
+ :see: https://lightning.bitflyer.com/docs?lang=en#get-trading-commission
495
495
  :param str symbol: unified market symbol
496
496
  :param dict [params]: extra parameters specific to the bitflyer api endpoint
497
497
  :returns dict: a `fee structure <https://github.com/ccxt/ccxt/wiki/Manual#fee-structure>`
@@ -518,7 +518,7 @@ class bitflyer(Exchange, ImplicitAPI):
518
518
  def create_order(self, symbol: str, type: OrderType, side: OrderSide, amount, price=None, params={}):
519
519
  """
520
520
  create a trade order
521
- see https://lightning.bitflyer.com/docs?lang=en#send-a-new-order
521
+ :see: https://lightning.bitflyer.com/docs?lang=en#send-a-new-order
522
522
  :param str symbol: unified symbol of the market to create an order in
523
523
  :param str type: 'market' or 'limit'
524
524
  :param str side: 'buy' or 'sell'
@@ -546,7 +546,7 @@ class bitflyer(Exchange, ImplicitAPI):
546
546
  def cancel_order(self, id: str, symbol: Optional[str] = None, params={}):
547
547
  """
548
548
  cancels an open order
549
- see https://lightning.bitflyer.com/docs?lang=en#cancel-order
549
+ :see: https://lightning.bitflyer.com/docs?lang=en#cancel-order
550
550
  :param str id: order id
551
551
  :param str symbol: unified symbol of the market the order was made in
552
552
  :param dict [params]: extra parameters specific to the bitflyer api endpoint
@@ -619,7 +619,7 @@ class bitflyer(Exchange, ImplicitAPI):
619
619
  def fetch_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit=100, params={}):
620
620
  """
621
621
  fetches information on multiple orders made by the user
622
- see https://lightning.bitflyer.com/docs?lang=en#list-orders
622
+ :see: https://lightning.bitflyer.com/docs?lang=en#list-orders
623
623
  :param str symbol: unified market symbol of the market orders were made in
624
624
  :param int [since]: the earliest time in ms to fetch orders for
625
625
  :param int [limit]: the maximum number of orde structures to retrieve
@@ -643,7 +643,7 @@ class bitflyer(Exchange, ImplicitAPI):
643
643
  def fetch_open_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit=100, params={}):
644
644
  """
645
645
  fetch all unfilled currently open orders
646
- see https://lightning.bitflyer.com/docs?lang=en#list-orders
646
+ :see: https://lightning.bitflyer.com/docs?lang=en#list-orders
647
647
  :param str symbol: unified market symbol
648
648
  :param int [since]: the earliest time in ms to fetch open orders for
649
649
  :param int [limit]: the maximum number of open orders structures to retrieve
@@ -658,7 +658,7 @@ class bitflyer(Exchange, ImplicitAPI):
658
658
  def fetch_closed_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit=100, params={}):
659
659
  """
660
660
  fetches information on multiple closed orders made by the user
661
- see https://lightning.bitflyer.com/docs?lang=en#list-orders
661
+ :see: https://lightning.bitflyer.com/docs?lang=en#list-orders
662
662
  :param str symbol: unified market symbol of the market orders were made in
663
663
  :param int [since]: the earliest time in ms to fetch orders for
664
664
  :param int [limit]: the maximum number of orde structures to retrieve
@@ -673,7 +673,7 @@ class bitflyer(Exchange, ImplicitAPI):
673
673
  def fetch_order(self, id: str, symbol: Optional[str] = None, params={}):
674
674
  """
675
675
  fetches information on an order made by the user
676
- see https://lightning.bitflyer.com/docs?lang=en#list-orders
676
+ :see: https://lightning.bitflyer.com/docs?lang=en#list-orders
677
677
  :param str symbol: unified symbol of the market the order was made in
678
678
  :param dict [params]: extra parameters specific to the bitflyer api endpoint
679
679
  :returns dict: An `order structure <https://github.com/ccxt/ccxt/wiki/Manual#order-structure>`
@@ -689,7 +689,7 @@ class bitflyer(Exchange, ImplicitAPI):
689
689
  def fetch_my_trades(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
690
690
  """
691
691
  fetch all trades made by the user
692
- see https://lightning.bitflyer.com/docs?lang=en#list-executions
692
+ :see: https://lightning.bitflyer.com/docs?lang=en#list-executions
693
693
  :param str symbol: unified market symbol
694
694
  :param int [since]: the earliest time in ms to fetch trades for
695
695
  :param int [limit]: the maximum number of trades structures to retrieve
@@ -725,7 +725,7 @@ class bitflyer(Exchange, ImplicitAPI):
725
725
  def fetch_positions(self, symbols: Optional[List[str]] = None, params={}):
726
726
  """
727
727
  fetch all open positions
728
- see https://lightning.bitflyer.com/docs?lang=en#get-open-interest-summary
728
+ :see: https://lightning.bitflyer.com/docs?lang=en#get-open-interest-summary
729
729
  :param str[] symbols: list of unified market symbols
730
730
  :param dict [params]: extra parameters specific to the bitflyer api endpoint
731
731
  :returns dict[]: a list of `position structure <https://github.com/ccxt/ccxt/wiki/Manual#position-structure>`
@@ -760,7 +760,7 @@ class bitflyer(Exchange, ImplicitAPI):
760
760
  def withdraw(self, code: str, amount, address, tag=None, params={}):
761
761
  """
762
762
  make a withdrawal
763
- see https://lightning.bitflyer.com/docs?lang=en#withdrawing-funds
763
+ :see: https://lightning.bitflyer.com/docs?lang=en#withdrawing-funds
764
764
  :param str code: unified currency code
765
765
  :param float amount: the amount to withdraw
766
766
  :param str address: the address to withdraw to
@@ -789,7 +789,7 @@ class bitflyer(Exchange, ImplicitAPI):
789
789
  def fetch_deposits(self, code: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
790
790
  """
791
791
  fetch all deposits made to an account
792
- see https://lightning.bitflyer.com/docs?lang=en#get-crypto-assets-deposit-history
792
+ :see: https://lightning.bitflyer.com/docs?lang=en#get-crypto-assets-deposit-history
793
793
  :param str code: unified currency code
794
794
  :param int [since]: the earliest time in ms to fetch deposits for
795
795
  :param int [limit]: the maximum number of deposits structures to retrieve
@@ -823,7 +823,7 @@ class bitflyer(Exchange, ImplicitAPI):
823
823
  def fetch_withdrawals(self, code: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
824
824
  """
825
825
  fetch all withdrawals made from an account
826
- see https://lightning.bitflyer.com/docs?lang=en#get-crypto-assets-transaction-history
826
+ :see: https://lightning.bitflyer.com/docs?lang=en#get-crypto-assets-transaction-history
827
827
  :param str code: unified currency code
828
828
  :param int [since]: the earliest time in ms to fetch withdrawals for
829
829
  :param int [limit]: the maximum number of withdrawals structures to retrieve
ccxt/bitforex.py CHANGED
@@ -165,7 +165,7 @@ class bitforex(Exchange, ImplicitAPI):
165
165
  def fetch_markets(self, params={}):
166
166
  """
167
167
  retrieves data on all markets for bitforex
168
- see https://apidoc.bitforex.com/#exchange-information
168
+ :see: https://apidoc.bitforex.com/#exchange-information
169
169
  :param dict [params]: extra parameters specific to the exchange api endpoint
170
170
  :returns dict[]: an array of objects representing market data
171
171
  """
@@ -316,7 +316,7 @@ class bitforex(Exchange, ImplicitAPI):
316
316
  def fetch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
317
317
  """
318
318
  get the list of most recent trades for a particular symbol
319
- see https://apidoc.bitforex.com/#recent-trades-list
319
+ :see: https://apidoc.bitforex.com/#recent-trades-list
320
320
  :param str symbol: unified symbol of the market to fetch trades for
321
321
  :param int [since]: timestamp in ms of the earliest trade to fetch
322
322
  :param int [limit]: the maximum amount of trades to fetch
@@ -352,7 +352,7 @@ class bitforex(Exchange, ImplicitAPI):
352
352
  def fetch_my_trades(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
353
353
  """
354
354
  fetch all trades made by the user
355
- see https://apidoc.bitforex.com/#spot-account-trade
355
+ :see: https://apidoc.bitforex.com/#spot-account-trade
356
356
  :param str symbol: unified market symbol
357
357
  :param int [since]: the earliest time in ms to fetch trades for
358
358
  :param int [limit]: the maximum number of trades structures to retrieve
@@ -420,7 +420,7 @@ class bitforex(Exchange, ImplicitAPI):
420
420
  def fetch_balance(self, params={}):
421
421
  """
422
422
  query for balance and get the amount of funds available for trading or funds locked in orders
423
- see https://apidoc.bitforex.com/#user-all-asset-information-user_data
423
+ :see: https://apidoc.bitforex.com/#user-all-asset-information-user_data
424
424
  :param dict [params]: extra parameters specific to the bitforex api endpoint
425
425
  :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
426
426
  """
@@ -468,7 +468,7 @@ class bitforex(Exchange, ImplicitAPI):
468
468
  def fetch_ticker(self, symbol: str, params={}):
469
469
  """
470
470
  fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
471
- see https://apidoc.bitforex.com/#exchange-information
471
+ :see: https://apidoc.bitforex.com/#exchange-information
472
472
  :param str symbol: unified symbol of the market to fetch the ticker for
473
473
  :param dict [params]: extra parameters specific to the bitforex api endpoint
474
474
  :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -521,7 +521,7 @@ class bitforex(Exchange, ImplicitAPI):
521
521
  def fetch_ohlcv(self, symbol: str, timeframe='1m', since: Optional[int] = None, limit: Optional[int] = None, params={}):
522
522
  """
523
523
  fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
524
- see https://apidoc.bitforex.com/#kline
524
+ :see: https://apidoc.bitforex.com/#kline
525
525
  :param str symbol: unified symbol of the market to fetch OHLCV data for
526
526
  :param str timeframe: the length of time each candle represents
527
527
  :param int [since]: timestamp in ms of the earliest candle to fetch
@@ -555,7 +555,7 @@ class bitforex(Exchange, ImplicitAPI):
555
555
  def fetch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
556
556
  """
557
557
  fetches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
558
- see https://apidoc.bitforex.com/#order-book
558
+ :see: https://apidoc.bitforex.com/#order-book
559
559
  :param str symbol: unified symbol of the market to fetch the order book for
560
560
  :param int [limit]: the maximum amount of order book entries to return
561
561
  :param dict [params]: extra parameters specific to the bitforex api endpoint
@@ -696,7 +696,7 @@ class bitforex(Exchange, ImplicitAPI):
696
696
  def create_order(self, symbol: str, type: OrderType, side: OrderSide, amount, price=None, params={}):
697
697
  """
698
698
  create a trade order
699
- see https://apidoc.bitforex.com/#new-order-trade
699
+ :see: https://apidoc.bitforex.com/#new-order-trade
700
700
  :param str symbol: unified symbol of the market to create an order in
701
701
  :param str type: 'market' or 'limit'
702
702
  :param str side: 'buy' or 'sell'
@@ -728,7 +728,7 @@ class bitforex(Exchange, ImplicitAPI):
728
728
  def cancel_order(self, id: str, symbol: Optional[str] = None, params={}):
729
729
  """
730
730
  cancels an open order
731
- see https://apidoc.bitforex.com/#cancel-order-trade
731
+ :see: https://apidoc.bitforex.com/#cancel-order-trade
732
732
  :param str id: order id
733
733
  :param str symbol: unified symbol of the market the order was made in
734
734
  :param dict [params]: extra parameters specific to the bitforex api endpoint