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

ccxt/async_support/okx.py

@@ -1154,7 +1154,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_status(self, params={}):
         """
         the latest known information on the availability of the exchange API
-        see https://www.okx.com/docs-v5/en/#status-get-status
+        :see: https://www.okx.com/docs-v5/en/#status-get-status
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: a `status structure <https://github.com/ccxt/ccxt/wiki/Manual#exchange-status-structure>`
         """
@@ -1199,7 +1199,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_time(self, params={}):
         """
         fetches the current integer timestamp in milliseconds from the exchange server
-        see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-system-time
+        :see: https://www.okx.com/docs-v5/en/#public-data-rest-api-get-system-time
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns int: the current integer timestamp in milliseconds from the exchange server
         """
@@ -1220,7 +1220,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_accounts(self, params={}):
         """
         fetch all the accounts associated with a profile
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-account-configuration
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-account-configuration
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: a dictionary of `account structures <https://github.com/ccxt/ccxt/wiki/Manual#account-structure>` indexed by the account type
         """
@@ -1262,7 +1262,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_markets(self, params={}):
         """
         retrieves data on all markets for okx
-        see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-instruments
+        :see: https://www.okx.com/docs-v5/en/#rest-api-public-data-get-instruments
         :param dict [params]: extra parameters specific to the exchange api endpoint
         :returns dict[]: an array of objects representing market data
         """
@@ -1489,7 +1489,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_currencies(self, params={}):
         """
         fetches all available currencies on an exchange
-        see https://www.okx.com/docs-v5/en/#rest-api-funding-get-currencies
+        :see: https://www.okx.com/docs-v5/en/#rest-api-funding-get-currencies
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: an associative dictionary of currencies
         """
@@ -1622,7 +1622,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
         """
         fetches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
-        see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-order-book
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-order-book
         :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 okx api endpoint
@@ -1721,7 +1721,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_ticker(self, symbol: str, params={}):
         """
         fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-        see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-ticker
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-ticker
         :param str symbol: unified symbol of the market to fetch the ticker for
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -1807,7 +1807,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_tickers(self, symbols: Optional[List[str]] = None, params={}):
         """
         fetches price tickers for multiple markets, statistical calculations with the information calculated over the past 24 hours each market
-        see https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-tickers
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-market-data-get-tickers
         :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 okx api endpoint
         :returns dict: a dictionary of `ticker structures <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -1914,8 +1914,8 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         get the list of most recent trades for a particular symbol
-        see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-trades
-        see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-option-trades
+        :see: https://www.okx.com/docs-v5/en/#rest-api-market-data-get-trades
+        :see: https://www.okx.com/docs-v5/en/#rest-api-public-data-get-option-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
@@ -2010,12 +2010,12 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_ohlcv(self, symbol: str, timeframe='1m', since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-        see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-candlesticks
-        see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-candlesticks-history
-        see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-mark-price-candlesticks
-        see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-mark-price-candlesticks-history
-        see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-index-candlesticks
-        see https://www.okx.com/docs-v5/en/#rest-api-market-data-get-index-candlesticks-history
+        :see: https://www.okx.com/docs-v5/en/#rest-api-market-data-get-candlesticks
+        :see: https://www.okx.com/docs-v5/en/#rest-api-market-data-get-candlesticks-history
+        :see: https://www.okx.com/docs-v5/en/#rest-api-market-data-get-mark-price-candlesticks
+        :see: https://www.okx.com/docs-v5/en/#rest-api-market-data-get-mark-price-candlesticks-history
+        :see: https://www.okx.com/docs-v5/en/#rest-api-market-data-get-index-candlesticks
+        :see: https://www.okx.com/docs-v5/en/#rest-api-market-data-get-index-candlesticks-history
         :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
@@ -2102,7 +2102,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_funding_rate_history(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetches historical funding rate prices
-        see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-funding-rate-history
+        :see: https://www.okx.com/docs-v5/en/#public-data-rest-api-get-funding-rate-history
         :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://github.com/ccxt/ccxt/wiki/Manual#funding-rate-history-structure>` to fetch
@@ -2234,7 +2234,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_trading_fee(self, symbol: str, params={}):
         """
         fetch the trading fees for a market
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-fee-rates
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-fee-rates
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: a `fee structure <https://github.com/ccxt/ccxt/wiki/Manual#fee-structure>`
@@ -2279,8 +2279,8 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_balance(self, params={}):
         """
         query for balance and get the amount of funds available for trading or funds locked in orders
-        see https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-balance
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-balance
+        :see: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-balance
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-balance
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
         """
@@ -2593,9 +2593,9 @@ class okx(Exchange, ImplicitAPI):
     async def create_order(self, symbol: str, type: OrderType, side: OrderSide, amount, price=None, params={}):
         """
         create a trade order
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-order
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-multiple-orders
-        see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-place-algo-order
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-order
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-place-multiple-orders
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-place-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'
@@ -2688,7 +2688,7 @@ class okx(Exchange, ImplicitAPI):
     async def edit_order(self, id: str, symbol, type, side, amount=None, price=None, params={}):
         """
         edit a trade order
-        see https://www.okx.com/docs-v5/en/#rest-api-trade-amend-order
+        :see: https://www.okx.com/docs-v5/en/#rest-api-trade-amend-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'
@@ -2742,7 +2742,7 @@ class okx(Exchange, ImplicitAPI):
     async def cancel_order(self, id: str, symbol: Optional[str] = None, params={}):
         """
         cancels an open order
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-order
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-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 okx api endpoint
@@ -2787,8 +2787,8 @@ class okx(Exchange, ImplicitAPI):
     async def cancel_orders(self, ids, symbol: Optional[str] = None, params={}):
         """
         cancel multiple orders
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-multiple-orders
-        see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-cancel-algo-order
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-post-cancel-multiple-orders
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-cancel-algo-order
         :param str[] ids: order ids
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -3071,8 +3071,8 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_order(self, id: str, symbol: Optional[str] = None, params={}):
         """
         fetch an order by the id
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-details
-        see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-details
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-details
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-details
         :param str id: the order id
         :param str symbol: unified market symbol
         :param dict [params]: extra and exchange specific parameters
@@ -3210,8 +3210,8 @@ class okx(Exchange, ImplicitAPI):
         """
         Fetch orders that are still open
         fetch all unfilled currently open orders
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-list
-        see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-list
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-list
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-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
@@ -3358,8 +3358,8 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_canceled_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetches information on multiple canceled orders made by the user
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-7-days
-        see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-history
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-7-days
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-history
         :param str symbol: unified market symbol of the market orders were made in
         :param int [since]: timestamp in ms of the earliest order, default is None
         :param int [limit]: max number of orders to return, default is None
@@ -3523,8 +3523,8 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_closed_orders(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetches information on multiple closed orders made by the user
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-7-days
-        see https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-history
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-order-history-last-7-days
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-get-algo-order-history
         :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
@@ -3685,7 +3685,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_my_trades(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetch all trades made by the user
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-transaction-details-last-3-months
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-transaction-details-last-3-months
         :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
@@ -3749,7 +3749,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_order_trades(self, id: str, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetch all the trades made from a single order
-        see https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-transaction-details-last-3-months
+        :see: https://www.okx.com/docs-v5/en/#order-book-trading-trade-get-transaction-details-last-3-months
         :param str id: order id
         :param str symbol: unified market symbol
         :param int [since]: the earliest time in ms to fetch trades for
@@ -3769,9 +3769,9 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_ledger(self, code: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetch the history of changes, actions done by the user or operations that altered balance of the user
-        see https://www.okx.com/docs-v5/en/#rest-api-account-get-bills-details-last-7-days
-        see https://www.okx.com/docs-v5/en/#rest-api-account-get-bills-details-last-3-months
-        see https://www.okx.com/docs-v5/en/#rest-api-funding-asset-bills-details
+        :see: https://www.okx.com/docs-v5/en/#rest-api-account-get-bills-details-last-7-days
+        :see: https://www.okx.com/docs-v5/en/#rest-api-account-get-bills-details-last-3-months
+        :see: https://www.okx.com/docs-v5/en/#rest-api-funding-asset-bills-details
         :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 entrys to return, default is None
@@ -4062,7 +4062,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_deposit_addresses_by_network(self, code: str, params={}):
         """
         fetch a dictionary of addresses for a currency, indexed by network
-        see https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address
+        :see: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address
         :param str code: unified currency code of the currency for the deposit address
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: a dictionary of `address structures <https://github.com/ccxt/ccxt/wiki/Manual#address-structure>` indexed by the network
@@ -4102,7 +4102,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_deposit_address(self, code: str, params={}):
         """
         fetch the deposit address for a currency associated with self account
-        see https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address
+        :see: https://www.okx.com/docs-v5/en/#funding-account-rest-api-get-deposit-address
         :param str code: unified currency code
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: an `address structure <https://github.com/ccxt/ccxt/wiki/Manual#address-structure>`
@@ -4135,7 +4135,7 @@ class okx(Exchange, ImplicitAPI):
     async def withdraw(self, code: str, amount, address, tag=None, params={}):
         """
         make a withdrawal
-        see https://www.okx.com/docs-v5/en/#funding-account-rest-api-withdrawal
+        :see: https://www.okx.com/docs-v5/en/#funding-account-rest-api-withdrawal
         :param str code: unified currency code
         :param float amount: the amount to withdraw
         :param str address: the address to withdraw to
@@ -4203,7 +4203,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_deposits(self, code: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetch all deposits made to an account
-        see https://www.okx.com/docs-v5/en/#rest-api-funding-get-deposit-history
+        :see: https://www.okx.com/docs-v5/en/#rest-api-funding-get-deposit-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
@@ -4278,7 +4278,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_deposit(self, id: str, code: Optional[str] = None, params={}):
         """
         fetch data on a currency deposit via the deposit id
-        see https://www.okx.com/docs-v5/en/#rest-api-funding-get-deposit-history
+        :see: https://www.okx.com/docs-v5/en/#rest-api-funding-get-deposit-history
         :param str id: deposit id
         :param str code: filter by currency code
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -4300,7 +4300,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_withdrawals(self, code: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetch all withdrawals made from an account
-        see https://www.okx.com/docs-v5/en/#rest-api-funding-get-withdrawal-history
+        :see: https://www.okx.com/docs-v5/en/#rest-api-funding-get-withdrawal-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
@@ -4367,7 +4367,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_withdrawal(self, id: str, code: Optional[str] = None, params={}):
         """
         fetch data on a currency withdrawal via the withdrawal id
-        see https://www.okx.com/docs-v5/en/#rest-api-funding-get-withdrawal-history
+        :see: https://www.okx.com/docs-v5/en/#rest-api-funding-get-withdrawal-history
         :param str id: withdrawal id
         :param str code: unified currency code of the currency withdrawn, default is None
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -4538,7 +4538,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_leverage(self, symbol: str, params={}):
         """
         fetch the set leverage for a market
-        see https://www.okx.com/docs-v5/en/#rest-api-account-get-leverage
+        :see: https://www.okx.com/docs-v5/en/#rest-api-account-get-leverage
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the okx api endpoint
         :param str [params.marginMode]: 'cross' or 'isolated'
@@ -4576,7 +4576,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_position(self, symbol: str, params={}):
         """
         fetch data on a single open contract trade position
-        see https://www.okx.com/docs-v5/en/#rest-api-account-get-positions
+        :see: https://www.okx.com/docs-v5/en/#rest-api-account-get-positions
         :param str symbol: unified market symbol of the market the position is held in, default is None
         :param dict [params]: extra parameters specific to the okx api endpoint
         :param str [params.instType]: MARGIN, SWAP, FUTURES, OPTION
@@ -4647,7 +4647,7 @@ class okx(Exchange, ImplicitAPI):
 
     async def fetch_positions(self, symbols: Optional[List[str]] = None, params={}):
         """
-        see https://www.okx.com/docs-v5/en/#rest-api-account-get-positions
+        :see: https://www.okx.com/docs-v5/en/#rest-api-account-get-positions
         fetch all open positions
         :param str[]|None symbols: list of unified market symbols
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -4859,7 +4859,7 @@ class okx(Exchange, ImplicitAPI):
     async def transfer(self, code: str, amount, fromAccount, toAccount, params={}):
         """
         transfer currency internally between wallets on the same account
-        see https://www.okx.com/docs-v5/en/#rest-api-funding-funds-transfer
+        :see: https://www.okx.com/docs-v5/en/#rest-api-funding-funds-transfer
         :param str code: unified currency code
         :param float amount: amount to transfer
         :param str fromAccount: account to transfer from
@@ -5029,7 +5029,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_transfers(self, code: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetch a history of internal transfers made on an account
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months
         :param str code: unified currency code of the currency transferred
         :param int [since]: the earliest time in ms to fetch transfers for
         :param int [limit]: the maximum number of transfers structures to retrieve
@@ -5178,7 +5178,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_funding_rate(self, symbol: str, params={}):
         """
         fetch the current funding rate
-        see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-funding-rate
+        :see: https://www.okx.com/docs-v5/en/#public-data-rest-api-get-funding-rate
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: a `funding rate structure <https://github.com/ccxt/ccxt/wiki/Manual#funding-rate-structure>`
@@ -5214,7 +5214,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_funding_history(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetch the history of funding payments paid and received on self account
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-bills-details-last-3-months
         :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
@@ -5364,7 +5364,7 @@ class okx(Exchange, ImplicitAPI):
     async def set_leverage(self, leverage, symbol: Optional[str] = None, params={}):
         """
         set the level of leverage for a market
-        see https://www.okx.com/docs-v5/en/#rest-api-account-set-leverage
+        :see: https://www.okx.com/docs-v5/en/#rest-api-account-set-leverage
         :param float leverage: the rate of leverage
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -5417,7 +5417,7 @@ class okx(Exchange, ImplicitAPI):
     async def set_position_mode(self, hedged, symbol: Optional[str] = None, params={}):
         """
         set hedged to True or False for a market
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-set-position-mode
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-set-position-mode
         :param bool hedged: set to True to use long_short_mode, False for net_mode
         :param str symbol: not used by okx setPositionMode
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -5448,7 +5448,7 @@ class okx(Exchange, ImplicitAPI):
     async def set_margin_mode(self, marginMode, symbol: Optional[str] = None, params={}):
         """
         set margin mode to 'cross' or 'isolated'
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-set-leverage
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-set-leverage
         :param str marginMode: 'cross' or 'isolated'
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -5493,7 +5493,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_borrow_rates(self, params={}):
         """
         fetch the borrow interest rates of all currencies
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-interest-rate
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-interest-rate
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: a list of `borrow rate structures <https://github.com/ccxt/ccxt/wiki/Manual#borrow-rate-structure>`
         """
@@ -5530,7 +5530,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_borrow_rate(self, code: str, params={}):
         """
         fetch the rate of interest to borrow a currency for margin trading
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-interest-rate
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-get-interest-rate
         :param str code: unified currency code
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict: a `borrow rate structure <https://github.com/ccxt/ccxt/wiki/Manual#borrow-rate-structure>`
@@ -5617,7 +5617,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_borrow_rate_histories(self, codes=None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         retrieves a history of a multiple currencies borrow interest rate at specific time slots, returns all currencies if no symbols passed, default is None
-        see https://www.okx.com/docs-v5/en/#financial-product-savings-get-public-borrow-history-public
+        :see: https://www.okx.com/docs-v5/en/#financial-product-savings-get-public-borrow-history-public
         :param str[]|None codes: list of unified currency codes, default is None
         :param int [since]: timestamp in ms of the earliest borrowRate, default is None
         :param int [limit]: max number of borrow rate prices to return, default is None
@@ -5656,7 +5656,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_borrow_rate_history(self, code: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         retrieves a history of a currencies borrow interest rate at specific time slots
-        see https://www.okx.com/docs-v5/en/#financial-product-savings-get-public-borrow-history-public
+        :see: https://www.okx.com/docs-v5/en/#financial-product-savings-get-public-borrow-history-public
         :param str code: unified currency code
         :param int [since]: timestamp for the earliest borrow rate
         :param int [limit]: the maximum number of `borrow rate structures <https://github.com/ccxt/ccxt/wiki/Manual#borrow-rate-structure>` to retrieve
@@ -5744,7 +5744,7 @@ class okx(Exchange, ImplicitAPI):
     async def reduce_margin(self, symbol: str, amount, params={}):
         """
         remove margin from a position
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-increase-decrease-margin
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-increase-decrease-margin
         :param str symbol: unified market symbol
         :param float amount: the amount of margin to remove
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -5755,7 +5755,7 @@ class okx(Exchange, ImplicitAPI):
     async def add_margin(self, symbol: str, amount, params={}):
         """
         add margin
-        see https://www.okx.com/docs-v5/en/#trading-account-rest-api-increase-decrease-margin
+        :see: https://www.okx.com/docs-v5/en/#trading-account-rest-api-increase-decrease-margin
         :param str symbol: unified market symbol
         :param float amount: amount of margin to add
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -5766,7 +5766,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_market_leverage_tiers(self, symbol: str, params={}):
         """
         retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes for a single market
-        see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-position-tiers
+        :see: https://www.okx.com/docs-v5/en/#rest-api-public-data-get-position-tiers
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the okx api endpoint
         :param str [params.marginMode]: 'cross' or 'isolated'
@@ -5856,7 +5856,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_borrow_interest(self, code: Optional[str] = None, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetch the interest owed by the user for borrowing currency for margin trading
-        see https://www.okx.com/docs-v5/en/#rest-api-account-get-interest-accrued-data
+        :see: https://www.okx.com/docs-v5/en/#rest-api-account-get-interest-accrued-data
         :param str code: the unified currency code for the currency of the interest
         :param str symbol: the market symbol of an isolated margin market, if None, the interest for cross margin markets is returned
         :param int [since]: timestamp in ms of the earliest time to receive interest records for
@@ -5929,7 +5929,7 @@ class okx(Exchange, ImplicitAPI):
     async def borrow_margin(self, code: str, amount, symbol: Optional[str] = None, params={}):
         """
         create a loan to borrow margin
-        see https://www.okx.com/docs-v5/en/#rest-api-account-vip-loans-borrow-and-repay
+        :see: https://www.okx.com/docs-v5/en/#rest-api-account-vip-loans-borrow-and-repay
         :param str code: unified currency code of the currency to borrow
         :param float amount: the amount to borrow
         :param str symbol: not used by okx.borrowMargin()
@@ -5971,7 +5971,7 @@ class okx(Exchange, ImplicitAPI):
     async def repay_margin(self, code: str, amount, symbol: Optional[str] = None, params={}):
         """
         repay borrowed margin and interest
-        see https://www.okx.com/docs-v5/en/#rest-api-account-vip-loans-borrow-and-repay
+        :see: https://www.okx.com/docs-v5/en/#rest-api-account-vip-loans-borrow-and-repay
         :param str code: unified currency code of the currency to repay
         :param float amount: the amount to repay
         :param str symbol: not used by okx.repayMargin()
@@ -6036,7 +6036,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_open_interest(self, symbol: str, params={}):
         """
         Retrieves the open interest of a currency
-        see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-open-interest
+        :see: https://www.okx.com/docs-v5/en/#rest-api-public-data-get-open-interest
         :param str symbol: Unified CCXT market symbol
         :param dict [params]: exchange specific parameters
         :returns dict} an open interest structure{@link https://github.com/ccxt/ccxt/wiki/Manual#interest-history-structure:
@@ -6074,8 +6074,8 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_open_interest_history(self, symbol: str, timeframe='1d', since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         Retrieves the open interest history of a currency
-        see https://www.okx.com/docs-v5/en/#rest-api-trading-data-get-contracts-open-interest-and-volume
-        see https://www.okx.com/docs-v5/en/#rest-api-trading-data-get-options-open-interest-and-volume
+        :see: https://www.okx.com/docs-v5/en/#rest-api-trading-data-get-contracts-open-interest-and-volume
+        :see: https://www.okx.com/docs-v5/en/#rest-api-trading-data-get-options-open-interest-and-volume
         :param str symbol: Unified CCXT currency code or unified symbol
         :param str timeframe: "5m", "1h", or "1d" for option only "1d" or "8h"
         :param int [since]: The time in ms of the earliest record to retrieve unix timestamp
@@ -6195,7 +6195,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_deposit_withdraw_fees(self, codes: Optional[List[str]] = None, params={}):
         """
         fetch deposit and withdraw fees
-        see https://www.okx.com/docs-v5/en/#rest-api-funding-get-currencies
+        :see: https://www.okx.com/docs-v5/en/#rest-api-funding-get-currencies
         :param str[]|None codes: list of unified currency codes
         :param dict [params]: extra parameters specific to the okx api endpoint
         :returns dict[]: a list of `fees structures <https://github.com/ccxt/ccxt/wiki/Manual#fee-structure>`
@@ -6308,7 +6308,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_settlement_history(self, symbol: Optional[str] = None, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         fetches historical settlement records
-        see https://www.okx.com/docs-v5/en/#rest-api-public-data-get-delivery-exercise-history
+        :see: https://www.okx.com/docs-v5/en/#rest-api-public-data-get-delivery-exercise-history
         :param str symbol: unified market symbol to fetch the settlement history for
         :param int [since]: timestamp in ms
         :param int [limit]: number of records
@@ -6400,7 +6400,7 @@ class okx(Exchange, ImplicitAPI):
     async def fetch_underlying_assets(self, params={}):
         """
         fetches the market ids of underlying assets for a specific contract market type
-        see https://www.okx.com/docs-v5/en/#public-data-rest-api-get-underlying
+        :see: https://www.okx.com/docs-v5/en/#public-data-rest-api-get-underlying
         :param dict [params]: exchange specific params
         :param str [params.type]: the contract market type, 'option', 'swap' or 'future', the default is 'option'
         :returns dict[]: a list of `underlying assets <https://github.com/ccxt/ccxt/wiki/Manual#underlying-assets-structure>`

ccxt/async_support/paymium.py

@@ -134,7 +134,7 @@ class paymium(Exchange, ImplicitAPI):
     async def fetch_balance(self, params={}):
         """
         query for balance and get the amount of funds available for trading or funds locked in orders
-        see https://paymium.github.io/api-documentation/#tag/User/paths/~1user/get
+        :see: https://paymium.github.io/api-documentation/#tag/User/paths/~1user/get
         :param dict [params]: extra parameters specific to the paymium api endpoint
         :returns dict: a `balance structure <https://github.com/ccxt/ccxt/wiki/Manual#balance-structure>`
         """
@@ -145,7 +145,7 @@ class paymium(Exchange, ImplicitAPI):
     async def fetch_order_book(self, symbol: str, limit: Optional[int] = None, params={}):
         """
         fetches information on open orders with bid(buy) and ask(sell) prices, volumes and other data
-        see https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1depth/get
+        :see: https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1depth/get
         :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 paymium api endpoint
@@ -210,7 +210,7 @@ class paymium(Exchange, ImplicitAPI):
     async def fetch_ticker(self, symbol: str, params={}):
         """
         fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-        see https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1ticker/get
+        :see: https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1ticker/get
         :param str symbol: unified symbol of the market to fetch the ticker for
         :param dict [params]: extra parameters specific to the paymium api endpoint
         :returns dict: a `ticker structure <https://github.com/ccxt/ccxt/wiki/Manual#ticker-structure>`
@@ -268,7 +268,7 @@ class paymium(Exchange, ImplicitAPI):
     async def fetch_trades(self, symbol: str, since: Optional[int] = None, limit: Optional[int] = None, params={}):
         """
         get the list of most recent trades for a particular symbol
-        see https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1trades/get
+        :see: https://paymium.github.io/api-documentation/#tag/Public-data/paths/~1data~1%7Bcurrency%7D~1trades/get
         :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
@@ -286,7 +286,7 @@ class paymium(Exchange, ImplicitAPI):
     async def create_deposit_address(self, code: str, params={}):
         """
         create a currency deposit address
-        see https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses/post
+        :see: https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses/post
         :param str code: unified currency code of the currency for the deposit address
         :param dict [params]: extra parameters specific to the paymium api endpoint
         :returns dict: an `address structure <https://github.com/ccxt/ccxt/wiki/Manual#address-structure>`
@@ -306,7 +306,7 @@ class paymium(Exchange, ImplicitAPI):
     async def fetch_deposit_address(self, code: str, params={}):
         """
         fetch the deposit address for a currency associated with self account
-        see https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses~1%7Baddress%7D/get
+        :see: https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses~1%7Baddress%7D/get
         :param str code: unified currency code
         :param dict [params]: extra parameters specific to the paymium api endpoint
         :returns dict: an `address structure <https://github.com/ccxt/ccxt/wiki/Manual#address-structure>`
@@ -329,7 +329,7 @@ class paymium(Exchange, ImplicitAPI):
     async def fetch_deposit_addresses(self, codes=None, params={}):
         """
         fetch deposit addresses for multiple currencies and chain types
-        see https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses/get
+        :see: https://paymium.github.io/api-documentation/#tag/User/paths/~1user~1addresses/get
         :param str[]|None codes: list of unified currency codes, default is None
         :param dict [params]: extra parameters specific to the paymium api endpoint
         :returns dict: a list of `address structures <https://github.com/ccxt/ccxt/wiki/Manual#address-structure>`
@@ -370,7 +370,7 @@ class paymium(Exchange, ImplicitAPI):
     async def create_order(self, symbol: str, type: OrderType, side: OrderSide, amount, price=None, params={}):
         """
         create a trade order
-        see https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders/post
+        :see: https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders/post
         :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'
@@ -398,8 +398,8 @@ class paymium(Exchange, ImplicitAPI):
     async def cancel_order(self, id: str, symbol: Optional[str] = None, params={}):
         """
         cancels an open order
-        see https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders~1%7Buuid%7D/delete
-        see https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders~1%7Buuid%7D~1cancel/delete
+        :see: https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders~1%7Buuid%7D/delete
+        :see: https://paymium.github.io/api-documentation/#tag/Order/paths/~1user~1orders~1%7Buuid%7D~1cancel/delete
         :param str id: order id
         :param str symbol: not used by paymium cancelOrder()
         :param dict [params]: extra parameters specific to the paymium api endpoint
@@ -413,7 +413,7 @@ class paymium(Exchange, ImplicitAPI):
     async def transfer(self, code: str, amount, fromAccount, toAccount, params={}):
         """
         transfer currency internally between wallets on the same account
-        see https://paymium.github.io/api-documentation/#tag/Transfer/paths/~1user~1email_transfers/post
+        :see: https://paymium.github.io/api-documentation/#tag/Transfer/paths/~1user~1email_transfers/post
         :param str code: unified currency code
         :param float amount: amount to transfer
         :param str fromAccount: account to transfer from