ccxt 4.4.30__py2.py3-none-any.whl → 4.4.31__py2.py3-none-any.whl

ccxt/poloniexfutures.py

@@ -220,7 +220,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_markets(self, params={}) -> List[Market]:
         """
         retrieves data on all markets for poloniexfutures
-        :see: https://api-docs.poloniex.com/futures/api/symbol
+
+        https://api-docs.poloniex.com/futures/api/symbol
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict[]: an array of objects representing market data
         """
@@ -426,7 +428,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_ticker(self, symbol: str, params={}) -> Ticker:
         """
         fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-        :see: https://api-docs.poloniex.com/futures/api/ticker#get-real-time-ticker-20
+
+        https://api-docs.poloniex.com/futures/api/ticker#get-real-time-ticker-20
+
         :param str symbol: unified symbol of the market to fetch the ticker for
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `ticker structure <https://docs.ccxt.com/#/?id=ticker-structure>`
@@ -460,7 +464,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_tickers(self, symbols: Strings = None, params={}) -> Tickers:
         """
         fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
-        :see: https://api-docs.poloniex.com/futures/api/ticker#get-real-time-ticker-of-all-symbols
+
+        https://api-docs.poloniex.com/futures/api/ticker#get-real-time-ticker-of-all-symbols
+
         :param str[]|None symbols: unified symbols of the markets to fetch the ticker for, all market tickers are returned if not assigned
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a dictionary of `ticker structures <https://docs.ccxt.com/#/?id=ticker-structure>`
@@ -473,8 +479,10 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
         """
         fetches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
-        :see: https://api-docs.poloniex.com/futures/api/orderbook#get-full-order-book---level-2
-        :see: https://api-docs.poloniex.com/futures/api/orderbook#get-full-order-book--level-3
+
+        https://api-docs.poloniex.com/futures/api/orderbook#get-full-order-book---level-2
+        https://api-docs.poloniex.com/futures/api/orderbook#get-full-order-book--level-3
+
         :param str symbol: unified symbol of the market to fetch the order book for
         :param int [limit]: the maximum amount of order book entries to return
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -553,7 +561,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_l3_order_book(self, symbol: str, limit: Int = None, params={}):
         """
         fetches level 3 information on open orders with bid(buy) and ask(sell) prices, volumes and other data
-        :see: https://api-docs.poloniex.com/futures/api/orderbook#get-full-order-book--level-3
+
+        https://api-docs.poloniex.com/futures/api/orderbook#get-full-order-book--level-3
+
         :param str symbol: unified market symbol
         :param int [limit]: max number of orders to return, default is None
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -652,7 +662,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={}) -> List[Trade]:
         """
         get the list of most recent trades for a particular symbol
-        :see: https://api-docs.poloniex.com/futures/api/historical#transaction-history
+
+        https://api-docs.poloniex.com/futures/api/historical#transaction-history
+
         :param str symbol: unified symbol of the market to fetch trades for
         :param int [since]: timestamp in ms of the earliest trade to fetch
         :param int [limit]: the maximum amount of trades to fetch
@@ -687,7 +699,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_time(self, params={}):
         """
         fetches the current integer timestamp in milliseconds from the poloniexfutures server
-        :see: https://api-docs.poloniex.com/futures/api/time#server-time
+
+        https://api-docs.poloniex.com/futures/api/time#server-time
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns int: the current integer timestamp in milliseconds from the poloniexfutures server
         """
@@ -704,7 +718,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
         """
         fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-        :see: https://api-docs.poloniex.com/futures/api/kline#get-k-line-data-of-contract
+
+        https://api-docs.poloniex.com/futures/api/kline#get-k-line-data-of-contract
+
         :param str symbol: unified symbol of the market to fetch OHLCV data for
         :param str timeframe: the length of time each candle represents
         :param int [since]: timestamp in ms of the earliest candle to fetch
@@ -766,7 +782,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_balance(self, params={}) -> Balances:
         """
         query for balance and get the amount of funds available for trading or funds locked in orders
-        :see: https://api-docs.poloniex.com/futures/api/account#get-account-overview
+
+        https://api-docs.poloniex.com/futures/api/account#get-account-overview
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `balance structure <https://docs.ccxt.com/#/?id=balance-structure>`
         """
@@ -799,7 +817,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def create_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={}):
         """
         Create an order on the exchange
-        :see: https://api-docs.poloniex.com/futures/api/orders#place-an-order
+
+        https://api-docs.poloniex.com/futures/api/orders#place-an-order
+
         :param str symbol: Unified CCXT market symbol
         :param str type: 'limit' or 'market'
         :param str side: 'buy' or 'sell'
@@ -896,7 +916,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def cancel_order(self, id: str, symbol: Str = None, params={}):
         """
         cancels an open order
-        :see: https://api-docs.poloniex.com/futures/api/orders#cancel-an-order
+
+        https://api-docs.poloniex.com/futures/api/orders#cancel-an-order
+
         :param str id: order id
         :param str symbol: unified symbol of the market the order was made in
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -933,7 +955,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_positions(self, symbols: Strings = None, params={}):
         """
         fetch all open positions
-        :see: https://api-docs.poloniex.com/futures/api/positions#get-position-list
+
+        https://api-docs.poloniex.com/futures/api/positions#get-position-list
+
         :param str[]|None symbols: list of unified market symbols
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict[]: a list of `position structure <https://docs.ccxt.com/#/?id=position-structure>`
@@ -1083,7 +1107,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_funding_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
         fetch the history of funding payments paid and received on self account
-        :see: https://api-docs.poloniex.com/futures/api/funding-fees#get-funding-history
+
+        https://api-docs.poloniex.com/futures/api/funding-fees#get-funding-history
+
         :param str symbol: unified market symbol
         :param int [since]: the earliest time in ms to fetch funding history for
         :param int [limit]: the maximum number of funding history structures to retrieve
@@ -1210,8 +1236,10 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_orders_by_status(self, status, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
         fetches a list of orders placed on the exchange
-        :see: https://api-docs.poloniex.com/futures/api/orders#get-order-listdeprecated
-        :see: https://api-docs.poloniex.com/futures/api/orders#get-untriggered-stop-order-list
+
+        https://api-docs.poloniex.com/futures/api/orders#get-order-listdeprecated
+        https://api-docs.poloniex.com/futures/api/orders#get-untriggered-stop-order-list
+
         :param str status: 'active' or 'closed', only 'active' is valid for stop orders
         :param str symbol: unified symbol for the market to retrieve orders from
         :param int [since]: timestamp in ms of the earliest order to retrieve
@@ -1308,8 +1336,10 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_open_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
         fetch all unfilled currently open orders
-        :see: https://api-docs.poloniex.com/futures/api/orders#get-order-listdeprecated
-        :see: https://api-docs.poloniex.com/futures/api/orders#get-untriggered-stop-order-list
+
+        https://api-docs.poloniex.com/futures/api/orders#get-order-listdeprecated
+        https://api-docs.poloniex.com/futures/api/orders#get-untriggered-stop-order-list
+
         :param str symbol: unified market symbol
         :param int [since]: the earliest time in ms to fetch open orders for
         :param int [limit]: the maximum number of  open orders structures to retrieve
@@ -1324,8 +1354,10 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
         fetches information on multiple closed orders made by the user
-        :see: https://api-docs.poloniex.com/futures/api/orders#get-order-listdeprecated
-        :see: https://api-docs.poloniex.com/futures/api/orders#get-untriggered-stop-order-list
+
+        https://api-docs.poloniex.com/futures/api/orders#get-order-listdeprecated
+        https://api-docs.poloniex.com/futures/api/orders#get-untriggered-stop-order-list
+
         :param str symbol: unified market symbol of the market orders were made in
         :param int [since]: the earliest time in ms to fetch orders for
         :param int [limit]: the maximum number of order structures to retrieve
@@ -1340,8 +1372,10 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_order(self, id: Str = None, symbol: Str = None, params={}):
         """
         fetches information on an order made by the user
-        :see: https://api-docs.poloniex.com/futures/api/orders#get-details-of-a-single-order
-        :see: https://api-docs.poloniex.com/futures/api/orders#get-single-order-by-clientoid
+
+        https://api-docs.poloniex.com/futures/api/orders#get-details-of-a-single-order
+        https://api-docs.poloniex.com/futures/api/orders#get-single-order-by-clientoid
+
         :param str id: the order id
         :param str symbol: unified symbol of the market the order was made in
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1532,7 +1566,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_funding_rate(self, symbol: str, params={}) -> FundingRate:
         """
         fetch the current funding rate
-        :see: https://api-docs.poloniex.com/futures/api/futures-index#get-premium-index
+
+        https://api-docs.poloniex.com/futures/api/futures-index#get-premium-index
+
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `funding rate structure <https://docs.ccxt.com/#/?id=funding-rate-structure>`
@@ -1558,7 +1594,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_funding_interval(self, symbol: str, params={}) -> FundingRate:
         """
         fetch the current funding rate interval
-        :see: https://api-docs.poloniex.com/futures/api/futures-index#get-premium-index
+
+        https://api-docs.poloniex.com/futures/api/futures-index#get-premium-index
+
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `funding rate structure <https://docs.ccxt.com/#/?id=funding-rate-structure>`
@@ -1611,15 +1649,17 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def fetch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
         fetch all trades made by the user
-        :see: https://api-docs.poloniex.com/futures/api/fills#get-fillsdeprecated
+
+        https://api-docs.poloniex.com/futures/api/fills#get-fillsdeprecated
+
         :param str symbol: unified market symbol
         :param int [since]: the earliest time in ms to fetch trades for
         :param int [limit]: the maximum number of trades structures to retrieve
         :param dict [params]: extra parameters specific to the exchange API endpoint
-        :param str orderIdFills: filles for a specific order(other parameters can be ignored if specified)
-        :param str side: buy or sell
-        :param str type:  limit, market, limit_stop or market_stop
-        :param int endAt: end time(milisecond)
+        :param str [params.orderIdFills]: filles for a specific order(other parameters can be ignored if specified)
+        :param str [params.side]: buy or sell
+        :param str [params.type]:  limit, market, limit_stop or market_stop
+        :param int [params.endAt]: end time(milisecond)
         :returns Trade[]: a list of `trade structures <https://docs.ccxt.com/#/?id=trade-structure>`
         """
         self.load_markets()
@@ -1672,7 +1712,9 @@ class poloniexfutures(Exchange, ImplicitAPI):
     def set_margin_mode(self, marginMode: str, symbol: Str = None, params={}):
         """
         set margin mode to 'cross' or 'isolated'
-        :see: https://api-docs.poloniex.com/futures/api/margin-mode#change-margin-mode
+
+        https://api-docs.poloniex.com/futures/api/margin-mode#change-margin-mode
+
         :param str marginMode: "0"(isolated) or "1"(cross)
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint

ccxt/pro/__init__.py

@@ -4,7 +4,7 @@
 
 # ----------------------------------------------------------------------------
 
-__version__ = '4.4.30'
+__version__ = '4.4.31'
 
 # ----------------------------------------------------------------------------
 

ccxt/pro/alpaca.py

@@ -56,7 +56,9 @@ class alpaca(ccxt.async_support.alpaca):
     async def watch_ticker(self, symbol: str, params={}) -> Ticker:
         """
         watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-        :see: https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#quotes
+
+        https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#quotes
+
         :param str symbol: unified symbol of the market to fetch the ticker for
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `ticker structure <https://docs.ccxt.com/#/?id=ticker-structure>`
@@ -130,7 +132,9 @@ class alpaca(ccxt.async_support.alpaca):
     async def watch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
         """
         watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-        :see: https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#bars
+
+        https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#bars
+
         :param str symbol: unified symbol of the market to fetch OHLCV data for
         :param str timeframe: the length of time each candle represents
         :param int [since]: timestamp in ms of the earliest candle to fetch
@@ -183,7 +187,9 @@ class alpaca(ccxt.async_support.alpaca):
     async def watch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
         """
         watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
-        :see: https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#orderbooks
+
+        https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#orderbooks
+
         :param str symbol: unified symbol of the market to fetch the order book for
         :param int [limit]: the maximum amount of order book entries to return.
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -257,7 +263,9 @@ class alpaca(ccxt.async_support.alpaca):
     async def watch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={}) -> List[Trade]:
         """
         watches information on multiple trades made in a market
-        :see: https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#trades
+
+        https://docs.alpaca.markets/docs/real-time-crypto-pricing-data#trades
+
         :param str symbol: unified market symbol of the market trades were made in
         :param int [since]: the earliest time in ms to fetch orders for
         :param int [limit]: the maximum number of trade structures to retrieve
@@ -306,7 +314,9 @@ class alpaca(ccxt.async_support.alpaca):
     async def watch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Trade]:
         """
         watches information on multiple trades made by the user
-        :see: https://docs.alpaca.markets/docs/websocket-streaming#trade-updates
+
+        https://docs.alpaca.markets/docs/websocket-streaming#trade-updates
+
         :param str symbol: unified market symbol of the market trades were made in
         :param int [since]: the earliest time in ms to fetch trades for
         :param int [limit]: the maximum number of trade structures to retrieve

ccxt/pro/ascendex.py

@@ -91,7 +91,9 @@ class ascendex(ccxt.async_support.ascendex):
     async def watch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
         """
         watches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-        :see: https://ascendex.github.io/ascendex-pro-api/#channel-bar-data
+
+        https://ascendex.github.io/ascendex-pro-api/#channel-bar-data
+
         :param str symbol: unified symbol of the market to fetch OHLCV data for
         :param str timeframe: the length of time each candle represents
         :param int [since]: timestamp in ms of the earliest candle to fetch
@@ -152,7 +154,9 @@ class ascendex(ccxt.async_support.ascendex):
     async def watch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={}) -> List[Trade]:
         """
         get the list of most recent trades for a particular symbol
-        :see: https://ascendex.github.io/ascendex-pro-api/#channel-market-trades
+
+        https://ascendex.github.io/ascendex-pro-api/#channel-market-trades
+
         :param str symbol: unified symbol of the market to fetch trades for
         :param int [since]: timestamp in ms of the earliest trade to fetch
         :param int [limit]: the maximum amount of trades to fetch
@@ -164,7 +168,9 @@ class ascendex(ccxt.async_support.ascendex):
     async def watch_trades_for_symbols(self, symbols: List[str], since: Int = None, limit: Int = None, params={}) -> List[Trade]:
         """
         get the list of most recent trades for a list of symbols
-        :see: https://ascendex.github.io/ascendex-pro-api/#channel-market-trades
+
+        https://ascendex.github.io/ascendex-pro-api/#channel-market-trades
+
         :param str[] symbols: unified symbol of the market to fetch trades for
         :param int [since]: timestamp in ms of the earliest trade to fetch
         :param int [limit]: the maximum amount of trades to fetch
@@ -229,7 +235,9 @@ class ascendex(ccxt.async_support.ascendex):
     async def watch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
         """
         watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
-        :see: https://ascendex.github.io/ascendex-pro-api/#channel-level-2-order-book-updates
+
+        https://ascendex.github.io/ascendex-pro-api/#channel-level-2-order-book-updates
+
         :param str symbol: unified symbol of the market to fetch the order book for
         :param int [limit]: the maximum amount of order book entries to return
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -377,7 +385,9 @@ class ascendex(ccxt.async_support.ascendex):
     async def watch_balance(self, params={}) -> Balances:
         """
         watch balance and get the amount of funds available for trading or funds locked in orders
-        :see: https://ascendex.github.io/ascendex-pro-api/#channel-order-and-balance
+
+        https://ascendex.github.io/ascendex-pro-api/#channel-order-and-balance
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `balance structure <https://docs.ccxt.com/#/?id=balance-structure>`
         """
@@ -490,7 +500,9 @@ class ascendex(ccxt.async_support.ascendex):
 
     async def watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
-        :see: https://ascendex.github.io/ascendex-pro-api/#channel-order-and-balance
+
+        https://ascendex.github.io/ascendex-pro-api/#channel-order-and-balance
+
         watches information on multiple orders made by the user
         :param str symbol: unified market symbol of the market orders were made in
         :param int [since]: the earliest time in ms to fetch orders for