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

ccxt/async_support/kucoinfutures.py

@@ -375,7 +375,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_status(self, params={}):
         """
         the latest known information on the availability of the exchange API
-        :see: https://www.kucoin.com/docs/rest/futures-trading/market-data/get-service-status
+
+        https://www.kucoin.com/docs/rest/futures-trading/market-data/get-service-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>`
         """
@@ -402,7 +404,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_markets(self, params={}) -> List[Market]:
         """
         retrieves data on all markets for kucoinfutures
-        :see: https://www.kucoin.com/docs/rest/futures-trading/market-data/get-symbols-list
+
+        https://www.kucoin.com/docs/rest/futures-trading/market-data/get-symbols-list
+
         :param dict [params]: extra parameters specific to the exchange api endpoint
         :returns dict[]: an array of objects representing market data
         """
@@ -560,7 +564,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_time(self, params={}):
         """
         fetches the current integer timestamp in milliseconds from the exchange server
-        :see: https://www.kucoin.com/docs/rest/futures-trading/market-data/get-server-time
+
+        https://www.kucoin.com/docs/rest/futures-trading/market-data/get-server-time
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns int: the current integer timestamp in milliseconds from the exchange server
         """
@@ -576,7 +582,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={}) -> List[list]:
         """
         fetches historical candlestick data containing the open, high, low, and close price, and the volume of a market
-        :see: https://www.kucoin.com/docs/rest/futures-trading/market-data/get-klines
+
+        https://www.kucoin.com/docs/rest/futures-trading/market-data/get-klines
+
         :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
@@ -649,7 +657,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_deposit_address(self, code: str, params={}) -> DepositAddress:
         """
         fetch the deposit address for a currency associated with self account
-        :see: https://www.kucoin.com/docs/rest/funding/deposit/get-deposit-address
+
+        https://www.kucoin.com/docs/rest/funding/deposit/get-deposit-address
+
         :param str code: unified currency code
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: an `address structure <https://docs.ccxt.com/#/?id=address-structure>`
@@ -686,7 +696,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async 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://www.kucoin.com/docs/rest/futures-trading/market-data/get-part-order-book-level-2
+
+        https://www.kucoin.com/docs/rest/futures-trading/market-data/get-part-order-book-level-2
+
         :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
@@ -735,7 +747,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_ticker(self, symbol: str, params={}) -> Ticker:
         """
         fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-        :see: https://www.kucoin.com/docs/rest/futures-trading/market-data/get-ticker
+
+        https://www.kucoin.com/docs/rest/futures-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 exchange API endpoint
         :returns dict: a `ticker structure <https://docs.ccxt.com/#/?id=ticker-structure>`
@@ -769,7 +783,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_mark_price(self, symbol: str, params={}) -> Ticker:
         """
         fetches a price ticker, a statistical calculation with the information calculated over the past 24 hours for a specific market
-        :see: https://www.kucoin.com/docs/rest/futures-trading/market-data/get-current-mark-price
+
+        https://www.kucoin.com/docs/rest/futures-trading/market-data/get-current-mark-price
+
         :param str symbol: unified symbol of the market to fetch the ticker for
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `ticker structure <https://docs.ccxt.com/#/?id=ticker-structure>`
@@ -786,7 +802,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_tickers(self, symbols: Strings = None, params={}) -> Tickers:
         """
         fetches price tickers for multiple markets, statistical information calculated over the past 24 hours for each market
-        :see: https://www.kucoin.com/docs/rest/futures-trading/market-data/get-symbols-list
+
+        https://www.kucoin.com/docs/rest/futures-trading/market-data/get-symbols-list
+
         :param str[] [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
         :param str [params.method]: the method to use, futuresPublicGetAllTickers or futuresPublicGetContractsActive
@@ -998,7 +1016,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_funding_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
         fetch the history of funding payments paid and received on self account
-        :see: https://www.kucoin.com/docs/rest/futures-trading/funding-fees/get-funding-history
+
+        https://www.kucoin.com/docs/rest/futures-trading/funding-fees/get-funding-history
+
         :param str symbol: unified market symbol
         :param int [since]: the earliest time in ms to fetch funding history for
         :param int [limit]: the maximum number of funding history structures to retrieve
@@ -1063,7 +1083,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
 
     async def fetch_position(self, symbol: str, params={}):
         """
-        :see: https://docs.kucoin.com/futures/#get-position-details
+
+        https://docs.kucoin.com/futures/#get-position-details
+
         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
@@ -1125,7 +1147,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_positions(self, symbols: Strings = None, params={}):
         """
         fetch all open positions
-        :see: https://docs.kucoin.com/futures/#get-position-list
+
+        https://docs.kucoin.com/futures/#get-position-list
+
         :param str[]|None symbols: list of unified market symbols
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict[]: a list of `position structure <https://docs.ccxt.com/#/?id=position-structure>`
@@ -1184,8 +1208,12 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_positions_history(self, symbols: Strings = None, since: Int = None, limit: Int = None, params={}):
         """
         fetches historical positions
-        :see: https://www.kucoin.com/docs/rest/futures-trading/positions/get-positions-history
+
+        https://www.kucoin.com/docs/rest/futures-trading/positions/get-positions-history
+
         :param str[] [symbols]: list of unified market symbols
+ @param since
+ @param limit
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :param int [params.until]: closing end time
         :param int [params.pageId]: page id
@@ -1375,8 +1403,10 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def create_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={}):
         """
         Create an order on the exchange
-        :see: https://docs.kucoin.com/futures/#place-an-order
-        :see: https://www.kucoin.com/docs/rest/futures-trading/orders/place-take-profit-and-stop-loss-order#http-request
+
+        https://docs.kucoin.com/futures/#place-an-order
+        https://www.kucoin.com/docs/rest/futures-trading/orders/place-take-profit-and-stop-loss-order#http-request
+
         :param str symbol: Unified CCXT market symbol
         :param str type: 'limit' or 'market'
         :param str side: 'buy' or 'sell'
@@ -1391,7 +1421,7 @@ class kucoinfutures(kucoin, ImplicitAPI):
         :param bool [params.reduceOnly]: A mark to reduce the position size only. Set to False by default. Need to set the position size when reduceOnly is True.
         :param str [params.timeInForce]: GTC, GTT, IOC, or FOK, default is GTC, limit orders only
         :param str [params.postOnly]: Post only flag, invalid when timeInForce is IOC or FOK
-         * ----------------- Exchange Specific Parameters -----------------
+ ----------------- Exchange Specific Parameters -----------------
         :param float [params.leverage]: Leverage size of the order
         :param str [params.clientOid]: client order id, defaults to uuid if not passed
         :param str [params.remark]: remark for the order, length cannot exceed 100 utf8 characters
@@ -1430,7 +1460,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def create_orders(self, orders: List[OrderRequest], params={}):
         """
         create a list of trade orders
-        :see: https://www.kucoin.com/docs/rest/futures-trading/orders/place-multiple-orders
+
+        https://www.kucoin.com/docs/rest/futures-trading/orders/place-multiple-orders
+
         :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>`
@@ -1552,7 +1584,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def cancel_order(self, id: str, symbol: Str = None, params={}):
         """
         cancels an open order
-        :see: https://www.kucoin.com/docs/rest/futures-trading/orders/cancel-futures-order-by-orderid
+
+        https://www.kucoin.com/docs/rest/futures-trading/orders/cancel-futures-order-by-orderid
+
         :param str id: order id
         :param str symbol: unified symbol of the market the order was made in
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1589,7 +1623,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def cancel_orders(self, ids, symbol: Str = None, params={}):
         """
         cancel multiple orders
-        :see: https://www.kucoin.com/docs/rest/futures-trading/orders/batch-cancel-orders
+
+        https://www.kucoin.com/docs/rest/futures-trading/orders/batch-cancel-orders
+
         :param str[] ids: order ids
         :param str symbol: unified symbol of the market the order was made in
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1644,8 +1680,10 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def cancel_all_orders(self, symbol: Str = None, params={}):
         """
         cancel all open orders
-        :see: https://www.kucoin.com/docs/rest/futures-trading/orders/cancel-multiple-futures-limit-orders
-        :see: https://www.kucoin.com/docs/rest/futures-trading/orders/cancel-multiple-futures-stop-orders
+
+        https://www.kucoin.com/docs/rest/futures-trading/orders/cancel-multiple-futures-limit-orders
+        https://www.kucoin.com/docs/rest/futures-trading/orders/cancel-multiple-futures-stop-orders
+
         :param str symbol: unified market symbol, only orders in the market of self symbol are cancelled when symbol is not None
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :param dict [params.trigger]: When True, all the trigger orders will be cancelled
@@ -1677,7 +1715,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def add_margin(self, symbol: str, amount: float, params={}) -> MarginModification:
         """
         add margin
-        :see: https://www.kucoin.com/docs/rest/futures-trading/positions/add-margin-manually
+
+        https://www.kucoin.com/docs/rest/futures-trading/positions/add-margin-manually
+
         :param str symbol: unified market symbol
         :param float amount: amount of margin to add
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -1816,8 +1856,10 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_orders_by_status(self, status, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
         fetches a list of orders placed on the exchange
-        :see: https://docs.kucoin.com/futures/#get-order-list
-        :see: https://docs.kucoin.com/futures/#get-untriggered-stop-order-list
+
+        https://docs.kucoin.com/futures/#get-order-list
+        https://docs.kucoin.com/futures/#get-untriggered-stop-order-list
+
         :param str status: 'active' or 'closed', only 'active' is valid for stop orders
         :param str symbol: unified symbol for the market to retrieve orders from
         :param int [since]: timestamp in ms of the earliest order to retrieve
@@ -1918,7 +1960,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
         fetches information on multiple closed orders made by the user
-        :see: https://docs.kucoin.com/futures/#get-order-list
+
+        https://docs.kucoin.com/futures/#get-order-list
+
         :param str symbol: unified market symbol of the market orders were made in
         :param int [since]: the earliest time in ms to fetch orders for
         :param int [limit]: the maximum number of order structures to retrieve
@@ -1939,8 +1983,10 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_open_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}) -> List[Order]:
         """
         fetches information on multiple open orders made by the user
-        :see: https://docs.kucoin.com/futures/#get-order-list
-        :see: https://docs.kucoin.com/futures/#get-untriggered-stop-order-list
+
+        https://docs.kucoin.com/futures/#get-order-list
+        https://docs.kucoin.com/futures/#get-untriggered-stop-order-list
+
         :param str symbol: unified market symbol of the market orders were made in
         :param int [since]: the earliest time in ms to fetch orders for
         :param int [limit]: the maximum number of order structures to retrieve
@@ -1962,7 +2008,10 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_order(self, id: Str = None, symbol: Str = None, params={}):
         """
         fetches information on an order made by the user
-        :see: https://docs.kucoin.com/futures/#get-details-of-a-single-order
+
+        https://docs.kucoin.com/futures/#get-details-of-a-single-order
+
+        :param str id: order id
         :param str symbol: unified symbol of the market the order was made in
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: An `order structure <https://docs.ccxt.com/#/?id=order-structure>`
@@ -2161,7 +2210,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_funding_rate(self, symbol: str, params={}) -> FundingRate:
         """
         fetch the current funding rate
-        :see: https://www.kucoin.com/docs/rest/futures-trading/funding-fees/get-current-funding-rate
+
+        https://www.kucoin.com/docs/rest/futures-trading/funding-fees/get-current-funding-rate
+
         :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>`
@@ -2191,7 +2242,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_funding_interval(self, symbol: str, params={}) -> FundingRate:
         """
         fetch the current funding rate interval
-        :see: https://www.kucoin.com/docs/rest/futures-trading/funding-fees/get-current-funding-rate
+
+        https://www.kucoin.com/docs/rest/futures-trading/funding-fees/get-current-funding-rate
+
         :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>`
@@ -2259,7 +2312,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async 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://www.kucoin.com/docs/rest/funding/funding-overview/get-account-detail-futures
+
+        https://www.kucoin.com/docs/rest/funding/funding-overview/get-account-detail-futures
+
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `balance structure <https://docs.ccxt.com/#/?id=balance-structure>`
         """
@@ -2356,7 +2411,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
 
     async def fetch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
-        :see: https://docs.kucoin.com/futures/#get-fills
+
+        https://docs.kucoin.com/futures/#get-fills
+
         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
@@ -2427,7 +2484,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async 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://www.kucoin.com/docs/rest/futures-trading/market-data/get-transaction-history
+
+        https://www.kucoin.com/docs/rest/futures-trading/market-data/get-transaction-history
+
         :param str symbol: unified symbol of the market to fetch trades for
         :param int [since]: timestamp in ms of the earliest trade to fetch
         :param int [limit]: the maximum amount of trades to fetch
@@ -2691,7 +2750,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_market_leverage_tiers(self, symbol: str, params={}) -> List[LeverageTier]:
         """
         retrieve information on the maximum leverage, and maintenance margin for trades of varying trade sizes for a single market
-        :see: https://www.kucoin.com/docs/rest/futures-trading/risk-limit/get-futures-risk-limit-level
+
+        https://www.kucoin.com/docs/rest/futures-trading/risk-limit/get-futures-risk-limit-level
+
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `leverage tiers structure <https://docs.ccxt.com/#/?id=leverage-tiers-structure>`
@@ -2726,7 +2787,7 @@ class kucoinfutures(kucoin, ImplicitAPI):
 
     def parse_market_leverage_tiers(self, info, market: Market = None) -> List[LeverageTier]:
         """
-         * @ignore
+ @ignore
         :param dict info: Exchange market response for 1 market
         :param dict market: CCXT market
         """
@@ -2744,8 +2805,10 @@ class kucoinfutures(kucoin, ImplicitAPI):
         tiers = []
         for i in range(0, len(info)):
             tier = info[i]
+            marketId = self.safe_string(tier, 'symbol')
             tiers.append({
                 'tier': self.safe_number(tier, 'level'),
+                'symbol': self.safe_symbol(marketId, market, None, 'contract'),
                 'currency': market['base'],
                 'minNotional': self.safe_number(tier, 'minRiskLimit'),
                 'maxNotional': self.safe_number(tier, 'maxRiskLimit'),
@@ -2757,7 +2820,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
 
     async def fetch_funding_rate_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={}):
         """
-        :see: https://www.kucoin.com/docs/rest/futures-trading/funding-fees/get-public-funding-history#request-url
+
+        https://www.kucoin.com/docs/rest/futures-trading/funding-fees/get-public-funding-history#request-url
+
         fetches historical funding rate prices
         :param str symbol: unified symbol of the market to fetch the funding rate history for
         :param int [since]: not used by kucuoinfutures
@@ -2815,7 +2880,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def close_position(self, symbol: str, side: OrderSide = None, params={}) -> Order:
         """
         closes open positions for a market
-        :see: https://www.kucoin.com/docs/rest/futures-trading/orders/place-order
+
+        https://www.kucoin.com/docs/rest/futures-trading/orders/place-order
+
         :param str symbol: Unified CCXT market symbol
         :param str side: not used by kucoinfutures closePositions
         :param dict [params]: extra parameters specific to the okx api endpoint
@@ -2845,7 +2912,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_trading_fee(self, symbol: str, params={}) -> TradingFeeInterface:
         """
         fetch the trading fees for a market
-        :see: https://www.kucoin.com/docs/rest/funding/trade-fee/trading-pair-actual-fee-futures
+
+        https://www.kucoin.com/docs/rest/funding/trade-fee/trading-pair-actual-fee-futures
+
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `fee structure <https://docs.ccxt.com/#/?id=fee-structure>`
@@ -2881,7 +2950,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_margin_mode(self, symbol: str, params={}) -> MarginMode:
         """
         fetches the margin mode of a trading pair
-        :see: https://www.kucoin.com/docs/rest/futures-trading/positions/get-margin-mode
+
+        https://www.kucoin.com/docs/rest/futures-trading/positions/get-margin-mode
+
         :param str symbol: unified symbol of the market to fetch the margin mode for
         :param dict [params]: extra parameters specific to the exchange API endpoint
         :returns dict: a `margin mode structure <https://docs.ccxt.com/#/?id=margin-mode-structure>`
@@ -2916,7 +2987,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def set_margin_mode(self, marginMode: str, symbol: Str = None, params={}):
         """
         set margin mode to 'cross' or 'isolated'
-        :see: https://www.kucoin.com/docs/rest/futures-trading/positions/modify-margin-mode
+
+        https://www.kucoin.com/docs/rest/futures-trading/positions/modify-margin-mode
+
         :param str marginMode: 'cross' or 'isolated'
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint
@@ -2947,7 +3020,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def fetch_leverage(self, symbol: str, params={}) -> Leverage:
         """
         fetch the set leverage for a market
-        :see: https://www.kucoin.com/docs/rest/futures-trading/positions/get-cross-margin-leverage
+
+        https://www.kucoin.com/docs/rest/futures-trading/positions/get-cross-margin-leverage
+
         :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>`
@@ -2980,7 +3055,9 @@ class kucoinfutures(kucoin, ImplicitAPI):
     async def set_leverage(self, leverage: Int, symbol: Str = None, params={}):
         """
         set the level of leverage for a market
-        :see: https://www.kucoin.com/docs/rest/futures-trading/positions/modify-cross-margin-leverage
+
+        https://www.kucoin.com/docs/rest/futures-trading/positions/modify-cross-margin-leverage
+
         :param float leverage: the rate of leverage
         :param str symbol: unified market symbol
         :param dict [params]: extra parameters specific to the exchange API endpoint