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

ccxt/woofipro.py

@@ -349,7 +349,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_status(self, params={}):
         """
         the latest known information on the availability of the exchange API
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-system-maintenance-status
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-system-maintenance-status
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `status structure <https://docs.ccxt.com/#/?id=exchange-status-structure>`
         """
@@ -383,7 +385,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_time(self, params={}):
         """
         fetches the current integer timestamp in milliseconds from the exchange server
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-system-maintenance-status
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-system-maintenance-status
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns int: the current integer timestamp in milliseconds from the exchange server
         """
@@ -491,7 +495,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_markets(self, params={}) -> List[Market]:
         """
         retrieves data on all markets for woofipro
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-available-symbols
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-available-symbols
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict[]: an array of objects representing market data
         """
@@ -538,7 +544,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_currencies(self, params={}) -> Currencies:
         """
         fetches all available currencies on an exchange
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-token-info
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-token-info
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: an associative dictionary of currencies
         """
@@ -704,7 +712,9 @@ class woofipro(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://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-market-trades
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-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
@@ -792,7 +802,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_funding_interval(self, symbol: str, params={}) -> FundingRate:
         """
         fetch the current funding rate interval
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-predicted-funding-rate-for-one-market
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-predicted-funding-rate-for-one-market
+
         :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>`
@@ -802,7 +814,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_funding_rate(self, symbol: str, params={}) -> FundingRate:
         """
         fetch the current funding rate
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-predicted-funding-rate-for-one-market
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-predicted-funding-rate-for-one-market
+
         :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>`
@@ -834,7 +848,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_funding_rates(self, symbols: Strings = None, params={}) -> FundingRates:
         """
         fetch the current funding rate for multiple markets
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-predicted-funding-rates-for-all-markets
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-predicted-funding-rates-for-all-markets
+
         :param str[] symbols: unified market symbols
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict[]: an array of `funding rate structures <https://docs.ccxt.com/#/?id=funding-rate-structure>`
@@ -867,7 +883,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_funding_rate_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
         fetches historical funding rate prices
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-funding-rate-history-for-one-market
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/public/get-funding-rate-history-for-one-market
+
         :param str symbol: unified symbol of the market to fetch the funding rate history for
         :param int [since]: timestamp in ms of the earliest funding rate to fetch
         :param int [limit]: the maximum amount of `funding rate structures <https://docs.ccxt.com/#/?id=funding-rate-history-structure>` to fetch
@@ -929,7 +947,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_trading_fees(self, params={}) -> TradingFees:
         """
         fetch the trading fees for multiple markets
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-account-information
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-account-information
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a dictionary of `fee structures <https://docs.ccxt.com/#/?id=fee-structure>` indexed by market symbols
         """
@@ -981,7 +1001,9 @@ class woofipro(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://orderly.network/docs/build-on-evm/evm-api/restful-api/private/orderbook-snapshot
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/orderbook-snapshot
+
         :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
@@ -1029,7 +1051,9 @@ class woofipro(Exchange, ImplicitAPI):
 
     def fetch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-kline
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-kline
+
         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
@@ -1218,7 +1242,7 @@ class woofipro(Exchange, ImplicitAPI):
 
     def create_order_request(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={}):
         """
-         * @ignore
+ @ignore
         helper function to build the request
         :param str symbol: unified symbol of the market to create an order in
         :param str type: 'market' or 'limit'
@@ -1305,8 +1329,10 @@ class woofipro(Exchange, ImplicitAPI):
     def create_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={}):
         """
         create a trade order
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/create-order
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/create-algo-order
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/create-order
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/create-algo-order
+
         :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'
@@ -1371,8 +1397,11 @@ class woofipro(Exchange, ImplicitAPI):
     def create_orders(self, orders: List[OrderRequest], params={}):
         """
         *contract only* create a list of trade orders
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/batch-create-order
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/batch-create-order
+
         :param Array orders: list of orders to create, each object should contain the parameters required by createOrder, namely symbol, type, side, amount, price and params
+        :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: an `order structure <https://docs.ccxt.com/#/?id=order-structure>`
         """
         self.load_markets()
@@ -1421,8 +1450,10 @@ class woofipro(Exchange, ImplicitAPI):
     def edit_order(self, id: str, symbol: str, type: OrderType, side: OrderSide, amount: Num = None, price: Num = None, params={}):
         """
         edit a trade order
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/edit-order
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/edit-algo-order
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/edit-order
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/edit-algo-order
+
         :param str id: order id
         :param str symbol: unified symbol of the market to create an order in
         :param str type: 'market' or 'limit'
@@ -1491,10 +1522,12 @@ class woofipro(Exchange, ImplicitAPI):
 
     def cancel_order(self, id: str, symbol: Str = None, params={}):
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-order
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-order-by-client_order_id
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-algo-order
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-algo-order-by-client_order_id
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-order
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-order-by-client_order_id
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-algo-order
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-algo-order-by-client_order_id
+
         cancels an open order
         :param str id: order id
         :param str symbol: unified symbol of the market the order was made in
@@ -1562,8 +1595,10 @@ class woofipro(Exchange, ImplicitAPI):
     def cancel_orders(self, ids: List[str], symbol: Str = None, params={}):
         """
         cancel multiple orders
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/batch-cancel-orders
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/batch-cancel-orders-by-client_order_id
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/batch-cancel-orders
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/batch-cancel-orders-by-client_order_id
+
         :param str[] ids: order ids
         :param str [symbol]: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1596,8 +1631,10 @@ class woofipro(Exchange, ImplicitAPI):
 
     def cancel_all_orders(self, symbol: Str = None, params={}):
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-all-pending-algo-orders
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-orders-in-bulk
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-all-pending-algo-orders
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/cancel-orders-in-bulk
+
         cancel all open orders in a market
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1639,10 +1676,12 @@ class woofipro(Exchange, ImplicitAPI):
 
     def fetch_order(self, id: str, symbol: Str = None, params={}):
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-order-by-order_id
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-order-by-client_order_id
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-order-by-order_id
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-order-by-client_order_id
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-order-by-order_id
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-order-by-client_order_id
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-order-by-order_id
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-order-by-client_order_id
+
         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
@@ -1705,8 +1744,10 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
         fetches information on multiple orders made by the user
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-orders
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-orders
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-orders
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-orders
+
         :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
@@ -1786,8 +1827,10 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_open_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
         fetches information on multiple orders made by the user
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-orders
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-orders
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-orders
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-orders
+
         :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
@@ -1806,8 +1849,10 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
         fetches information on multiple orders made by the user
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-orders
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-orders
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-orders
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-algo-orders
+
         :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
@@ -1826,7 +1871,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_order_trades(self, id: str, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
         fetch all the trades made from a single order
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-all-trades-of-specific-order
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-all-trades-of-specific-order
+
         :param str id: order id
         :param str symbol: unified market symbol
         :param int [since]: the earliest time in ms to fetch trades for
@@ -1869,7 +1916,9 @@ class woofipro(Exchange, ImplicitAPI):
 
     def fetch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-trades
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-trades
+
         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
@@ -1944,7 +1993,9 @@ class woofipro(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://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-current-holding
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-current-holding
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `balance structure <https://docs.ccxt.com/#/?id=balance-structure>`
         """
@@ -2049,7 +2100,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_ledger(self, code: Str = None, since: Int = None, limit: Int = None, params={}) -> List[LedgerEntry]:
         """
         fetch the history of changes, actions done by the user or operations that altered the balance of the user
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history
+
         :param str [code]: unified currency code, default is None
         :param int [since]: timestamp in ms of the earliest ledger entry, default is None
         :param int [limit]: max number of ledger entries to return, default is None
@@ -2105,7 +2158,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_deposits(self, code: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Transaction]:
         """
         fetch all deposits made to an account
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history
+
         :param str code: unified currency code
         :param int [since]: the earliest time in ms to fetch deposits for
         :param int [limit]: the maximum number of deposits structures to retrieve
@@ -2120,7 +2175,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_withdrawals(self, code: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Transaction]:
         """
         fetch all withdrawals made from an account
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history
+
         :param str code: unified currency code
         :param int [since]: the earliest time in ms to fetch withdrawals for
         :param int [limit]: the maximum number of withdrawals structures to retrieve
@@ -2135,7 +2192,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_deposits_withdrawals(self, code: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Transaction]:
         """
         fetch history of deposits and withdrawals
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-asset-history
+
         :param str [code]: unified currency code for the currency of the deposit/withdrawals, default is None
         :param int [since]: timestamp in ms of the earliest deposit/withdrawal, default is None
         :param int [limit]: max number of deposit/withdrawals to return, default is None
@@ -2187,7 +2246,9 @@ class woofipro(Exchange, ImplicitAPI):
     def withdraw(self, code: str, amount: float, address: str, tag=None, params={}) -> Transaction:
         """
         make a withdrawal
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/create-withdraw-request
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/create-withdraw-request
+
         :param str code: unified currency code
         :param float amount: the amount to withdraw
         :param str address: the address to withdraw to
@@ -2272,7 +2333,9 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_leverage(self, symbol: str, params={}) -> Leverage:
         """
         fetch the set leverage for a market
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-account-information
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-account-information
+
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `leverage structure <https://docs.ccxt.com/#/?id=leverage-structure>`
@@ -2313,8 +2376,11 @@ class woofipro(Exchange, ImplicitAPI):
     def set_leverage(self, leverage: Int, symbol: Str = None, params={}):
         """
         set the level of leverage for a market
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/update-leverage-setting
-        :param str symbol: unified market symbol
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/update-leverage-setting
+
+        :param int [leverage]: the rate of leverage
+        :param str [symbol]: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: response from the exchange
         """
@@ -2397,7 +2463,9 @@ class woofipro(Exchange, ImplicitAPI):
 
     def fetch_position(self, symbol: Str = None, params={}):
         """
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-one-position-info
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-one-position-info
+
         fetch data on an open position
         :param str symbol: unified market symbol of the market the position is held in
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -2441,10 +2509,11 @@ class woofipro(Exchange, ImplicitAPI):
     def fetch_positions(self, symbols: Strings = None, params={}):
         """
         fetch all open positions
-        :see: https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-all-positions-info
+
+        https://orderly.network/docs/build-on-evm/evm-api/restful-api/private/get-all-positions-info
+
         :param str[] [symbols]: list of unified market symbols
         :param dict [params]: extra parameters specific to the exchange API endpoint
-        :param str [method]: method name to call, "positionRisk", "account" or "option", default is "positionRisk"
         :returns dict[]: a list of `position structure <https://docs.ccxt.com/#/?id=position-structure>`
         """
         self.load_markets()