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

ccxt/pro/woofipro.py

@@ -94,7 +94,9 @@ class woofipro(ccxt.async_support.woofipro):
 
     async def watch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/orderbook
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/orderbook
+
         watches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
         :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.
@@ -150,7 +152,9 @@ class woofipro(ccxt.async_support.woofipro):
 
     async def watch_ticker(self, symbol: str, params={}) -> Ticker:
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/24-hour-ticker
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/24-hour-ticker
+
         watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
         :param str symbol: unified symbol of the market to fetch the ticker for
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -235,7 +239,9 @@ class woofipro(ccxt.async_support.woofipro):
 
     async def watch_tickers(self, symbols: Strings = None, params={}) -> Tickers:
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/24-hour-tickers
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/24-hour-tickers
+
         watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for all markets of a specific list
         :param str[] symbols: unified symbol of the market to fetch the ticker for
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -287,7 +293,9 @@ class woofipro(ccxt.async_support.woofipro):
 
     async def watch_bids_asks(self, symbols: Strings = None, params={}) -> Tickers:
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/bbos
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/bbos
+
         watches best bid & ask for symbols
         :param str[] symbols: unified symbol of the market to fetch the ticker for
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -350,7 +358,9 @@ class woofipro(ccxt.async_support.woofipro):
     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://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/k-line
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/k-line
+
         :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
@@ -422,7 +432,9 @@ class woofipro(ccxt.async_support.woofipro):
     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://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/trade
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/public/trade
+
         :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
@@ -616,8 +628,10 @@ class woofipro(ccxt.async_support.woofipro):
     async def watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
         watches information on multiple orders made by the user
-        :see: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/execution-report
-        :see: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/algo-execution-report
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/execution-report
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/algo-execution-report
+
         :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
@@ -647,8 +661,10 @@ class woofipro(ccxt.async_support.woofipro):
     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://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/execution-report
-        :see: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/algo-execution-report
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/execution-report
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/algo-execution-report
+
         :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
@@ -911,9 +927,13 @@ class woofipro(ccxt.async_support.woofipro):
 
     async def watch_positions(self, symbols: Strings = None, since: Int = None, limit: Int = None, params={}) -> List[Position]:
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/position-push
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/position-push
+
         watch all open positions
-        :param str[]|None symbols: list of unified market symbols
+        :param str[] [symbols]: list of unified market symbols
+ @param since timestamp in ms of the earliest position to fetch
+ @param limit the maximum number of positions to fetch
         :param dict params: extra parameters specific to the exchange API endpoint
         :returns dict[]: a list of `position structure <https://docs.ccxt.com/en/latest/manual.html#position-structure>`
         """
@@ -1091,7 +1111,9 @@ class woofipro(ccxt.async_support.woofipro):
     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://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/balance
+
+        https://orderly.network/docs/build-on-evm/evm-api/websocket-api/private/balance
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `balance structure <https://docs.ccxt.com/#/?id=balance-structure>`
         """

ccxt/pro/xt.py

@@ -55,11 +55,13 @@ class xt(ccxt.async_support.xt):
 
     async def get_listen_key(self, isContract: bool):
         """
-         * @ignore
+ @ignore
         required for private endpoints
         :param str isContract: True for contract trades
-        :see: https://doc.xt.com/#websocket_privategetToken
-        :see: https://doc.xt.com/#futures_user_websocket_v2base
+
+        https://doc.xt.com/#websocket_privategetToken
+        https://doc.xt.com/#futures_user_websocket_v2base
+
         :returns str: listen key / access token
         """
         self.check_required_credentials()
@@ -133,10 +135,12 @@ class xt(ccxt.async_support.xt):
 
     async def subscribe(self, name: str, access: str, methodName: str, market: Market = None, symbols: List[str] = None, params={}):
         """
-         * @ignore
+ @ignore
         Connects to a websocket channel
-        :see: https://doc.xt.com/#websocket_privaterequestFormat
-        :see: https://doc.xt.com/#futures_market_websocket_v2base
+
+        https://doc.xt.com/#websocket_privaterequestFormat
+        https://doc.xt.com/#futures_market_websocket_v2base
+
         :param str name: name of the channel
         :param str access: public or private
         :param str methodName: the name of the CCXT class method
@@ -177,9 +181,11 @@ class xt(ccxt.async_support.xt):
     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://doc.xt.com/#websocket_publictickerRealTime
-        :see: https://doc.xt.com/#futures_market_websocket_v2tickerRealTime
-        :see: https://doc.xt.com/#futures_market_websocket_v2aggTickerRealTime
+
+        https://doc.xt.com/#websocket_publictickerRealTime
+        https://doc.xt.com/#futures_market_websocket_v2tickerRealTime
+        https://doc.xt.com/#futures_market_websocket_v2aggTickerRealTime
+
         :param str symbol: unified symbol of the market to fetch the ticker for
         :param dict params: extra parameters specific to the xt api endpoint
         :param str [params.method]: 'agg_ticker'(contract only) or 'ticker', default = 'ticker' - the endpoint that will be streamed
@@ -196,9 +202,11 @@ class xt(ccxt.async_support.xt):
     async def watch_tickers(self, symbols: Strings = None, params={}) -> Tickers:
         """
         watches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-        :see: https://doc.xt.com/#websocket_publicallTicker
-        :see: https://doc.xt.com/#futures_market_websocket_v2allTicker
-        :see: https://doc.xt.com/#futures_market_websocket_v2allAggTicker
+
+        https://doc.xt.com/#websocket_publicallTicker
+        https://doc.xt.com/#futures_market_websocket_v2allTicker
+        https://doc.xt.com/#futures_market_websocket_v2allAggTicker
+
         :param str [symbols]: unified market symbols
         :param dict params: extra parameters specific to the xt api endpoint
         :param str [params.method]: 'agg_tickers'(contract only) or 'tickers', default = 'tickers' - the endpoint that will be streamed
@@ -219,8 +227,10 @@ class xt(ccxt.async_support.xt):
     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://doc.xt.com/#websocket_publicsymbolKline
-        :see: https://doc.xt.com/#futures_market_websocket_v2symbolKline
+
+        https://doc.xt.com/#websocket_publicsymbolKline
+        https://doc.xt.com/#futures_market_websocket_v2symbolKline
+
         :param str symbol: unified symbol of the market to fetch OHLCV data for
         :param str timeframe: 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, or 1M
         :param int [since]: not used by xt watchOHLCV
@@ -239,8 +249,10 @@ class xt(ccxt.async_support.xt):
     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://doc.xt.com/#websocket_publicdealRecord
-        :see: https://doc.xt.com/#futures_market_websocket_v2dealRecord
+
+        https://doc.xt.com/#websocket_publicdealRecord
+        https://doc.xt.com/#futures_market_websocket_v2dealRecord
+
         :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
@@ -258,10 +270,12 @@ class xt(ccxt.async_support.xt):
     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://doc.xt.com/#websocket_publiclimitDepth
-        :see: https://doc.xt.com/#websocket_publicincreDepth
-        :see: https://doc.xt.com/#futures_market_websocket_v2limitDepth
-        :see: https://doc.xt.com/#futures_market_websocket_v2increDepth
+
+        https://doc.xt.com/#websocket_publiclimitDepth
+        https://doc.xt.com/#websocket_publicincreDepth
+        https://doc.xt.com/#futures_market_websocket_v2limitDepth
+        https://doc.xt.com/#futures_market_websocket_v2increDepth
+
         :param str symbol: unified symbol of the market to fetch the order book for
         :param int [limit]: not used by xt watchOrderBook
         :param dict params: extra parameters specific to the xt api endpoint
@@ -281,8 +295,10 @@ class xt(ccxt.async_support.xt):
     async def watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
         watches information on multiple orders made by the user
-        :see: https://doc.xt.com/#websocket_privateorderChange
-        :see: https://doc.xt.com/#futures_user_websocket_v2order
+
+        https://doc.xt.com/#websocket_privateorderChange
+        https://doc.xt.com/#futures_user_websocket_v2order
+
         :param str [symbol]: unified market symbol
         :param int [since]: not used by xt watchOrders
         :param int [limit]: the maximum number of orders to return
@@ -302,8 +318,10 @@ class xt(ccxt.async_support.xt):
     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://doc.xt.com/#websocket_privateorderDeal
-        :see: https://doc.xt.com/#futures_user_websocket_v2trade
+
+        https://doc.xt.com/#websocket_privateorderDeal
+        https://doc.xt.com/#futures_user_websocket_v2trade
+
         :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  orde structures to retrieve
@@ -323,8 +341,10 @@ class xt(ccxt.async_support.xt):
     async def watch_balance(self, params={}) -> Balances:
         """
         watches information on multiple orders made by the user
-        :see: https://doc.xt.com/#websocket_privatebalanceChange
-        :see: https://doc.xt.com/#futures_user_websocket_v2balance
+
+        https://doc.xt.com/#websocket_privatebalanceChange
+        https://doc.xt.com/#futures_user_websocket_v2balance
+
         :param dict params: extra parameters specific to the xt api endpoint
         :returns dict[]: a list of `balance structures <https://docs.ccxt.com/#/?id=balance-structure>`
         """

ccxt/probit.py

@@ -245,7 +245,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_markets(self, params={}) -> List[Market]:
         """
-        :see: https://docs-en.probit.com/reference/market
+
+        https://docs-en.probit.com/reference/market
+
         retrieves data on all markets for probit
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict[]: an array of objects representing market data
@@ -344,7 +346,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_currencies(self, params={}) -> Currencies:
         """
-        :see: https://docs-en.probit.com/reference/currency
+
+        https://docs-en.probit.com/reference/currency
+
         fetches all available currencies on an exchange
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: an associative dictionary of currencies
@@ -525,7 +529,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_balance(self, params={}) -> Balances:
         """
-        :see: https://docs-en.probit.com/reference/balance
+
+        https://docs-en.probit.com/reference/balance
+
         query for balance and get the amount of funds available for trading or funds locked in orders
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `balance structure <https://docs.ccxt.com/#/?id=balance-structure>`
@@ -547,7 +553,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_order_book(self, symbol: str, limit: Int = None, params={}) -> OrderBook:
         """
-        :see: https://docs-en.probit.com/reference/order_book
+
+        https://docs-en.probit.com/reference/order_book
+
         fetches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
         :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
@@ -575,7 +583,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_tickers(self, symbols: Strings = None, params={}) -> Tickers:
         """
-        :see: https://docs-en.probit.com/reference/ticker
+
+        https://docs-en.probit.com/reference/ticker
+
         fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
         :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
@@ -608,7 +618,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_ticker(self, symbol: str, params={}) -> Ticker:
         """
-        :see: https://docs-en.probit.com/reference/ticker
+
+        https://docs-en.probit.com/reference/ticker
+
         fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
         :param str symbol: unified symbol of the market to fetch the ticker for
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -687,7 +699,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
-        :see: https://docs-en.probit.com/reference/trade
+
+        https://docs-en.probit.com/reference/trade
+
         fetch all trades made by the user
         :param str symbol: unified market symbol
         :param int [since]: the earliest time in ms to fetch trades for
@@ -736,7 +750,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={}) -> List[Trade]:
         """
-        :see: https://docs-en.probit.com/reference/trade-1
+
+        https://docs-en.probit.com/reference/trade-1
+
         get the list of most recent trades for a particular symbol
         :param str symbol: unified symbol of the market to fetch trades for
         :param int [since]: timestamp in ms of the earliest trade to fetch
@@ -851,7 +867,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_time(self, params={}):
         """
-        :see: https://docs-en.probit.com/reference/time
+
+        https://docs-en.probit.com/reference/time
+
         fetches the current integer timestamp in milliseconds from the exchange server
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns int: the current integer timestamp in milliseconds from the exchange server
@@ -894,7 +912,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
         """
-        :see: https://docs-en.probit.com/reference/candle
+
+        https://docs-en.probit.com/reference/candle
+
         fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
         :param str symbol: unified symbol of the market to fetch OHLCV data for
         :param str timeframe: the length of time each candle represents
@@ -978,7 +998,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_open_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
-        :see: https://docs-en.probit.com/reference/open_order-1
+
+        https://docs-en.probit.com/reference/open_order-1
+
         fetch all unfilled currently open orders
         :param str symbol: unified market symbol
         :param int [since]: the earliest time in ms to fetch open orders for
@@ -999,7 +1021,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
-        :see: https://docs-en.probit.com/reference/order
+
+        https://docs-en.probit.com/reference/order
+
         fetches information on multiple closed 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
@@ -1027,7 +1051,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_order(self, id: str, symbol: Str = None, params={}):
         """
-        :see: https://docs-en.probit.com/reference/order-3
+
+        https://docs-en.probit.com/reference/order-3
+
         fetches information on an order made by the user
         :param str id: the order id
         :param str symbol: unified symbol of the market the order was made in
@@ -1129,7 +1155,9 @@ class probit(Exchange, ImplicitAPI):
     def create_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={}):
         """
         create a trade order
-        :see: https://docs-en.probit.com/reference/order-1
+
+        https://docs-en.probit.com/reference/order-1
+
         :param str symbol: unified symbol of the market to create an order in
         :param str type: 'market' or 'limit'
         :param str side: 'buy' or 'sell'
@@ -1214,7 +1242,9 @@ class probit(Exchange, ImplicitAPI):
 
     def cancel_order(self, id: str, symbol: Str = None, params={}):
         """
-        :see: https://docs-en.probit.com/reference/order-2
+
+        https://docs-en.probit.com/reference/order-2
+
         cancels an open order
         :param str id: order id
         :param str symbol: unified symbol of the market the order was made in
@@ -1251,7 +1281,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_deposit_address(self, code: str, params={}) -> DepositAddress:
         """
-        :see: https://docs-en.probit.com/reference/deposit_address
+
+        https://docs-en.probit.com/reference/deposit_address
+
         fetch the deposit address for a currency associated with self account
         :param str code: unified currency code
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1301,7 +1333,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_deposit_addresses(self, codes: Strings = None, params={}) -> List[DepositAddress]:
         """
-        :see: https://docs-en.probit.com/reference/deposit_address
+
+        https://docs-en.probit.com/reference/deposit_address
+
         fetch deposit addresses for multiple currencies and chain types
         :param str[]|None codes: list of unified currency codes, default is None
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1321,7 +1355,9 @@ class probit(Exchange, ImplicitAPI):
 
     def withdraw(self, code: str, amount: float, address: str, tag=None, params={}) -> Transaction:
         """
-        :see: https://docs-en.probit.com/reference/withdrawal
+
+        https://docs-en.probit.com/reference/withdrawal
+
         make a withdrawal
         :param str code: unified currency code
         :param float amount: the amount to withdraw
@@ -1395,12 +1431,14 @@ class probit(Exchange, ImplicitAPI):
     def fetch_deposits_withdrawals(self, code: Str = None, since: Int = None, limit: Int = None, params={}):
         """
         fetch history of deposits and withdrawals
-        :see: https://docs-en.probit.com/reference/transferpayment
+
+        https://docs-en.probit.com/reference/transferpayment
+
         :param str code: unified currency code
         :param int [since]: the earliest time in ms to fetch transactions for
         :param int [limit]: the maximum number of transaction structures to retrieve
-        :param int [params.until]: the latest time in ms to fetch transactions for
         :param dict [params]: extra parameters specific to the exchange API endpoint
+        :param int [params.until]: the latest time in ms to fetch transactions for
         :returns dict[]: a list of `transaction structures <https://docs.ccxt.com/#/?id=transaction-structure>`
         """
         self.load_markets()
@@ -1529,7 +1567,9 @@ class probit(Exchange, ImplicitAPI):
 
     def fetch_deposit_withdraw_fees(self, codes: Strings = None, params={}):
         """
-        :see: https://docs-en.probit.com/reference/currency
+
+        https://docs-en.probit.com/reference/currency
+
         fetch deposit and withdraw fees
         :param str[]|None codes: list of unified currency codes
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1700,7 +1740,9 @@ class probit(Exchange, ImplicitAPI):
 
     def sign_in(self, params={}):
         """
-        :see: https://docs-en.probit.com/reference/token
+
+        https://docs-en.probit.com/reference/token
+
         sign in, must be called prior to using other authenticated methods
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns: response from exchange