a Gc @s,dZddlmZmZmZGdddeZdS)z connector.py Define abstract exchange connector class. All classes implementing an exchange API connector shall inherit this class. Output formats are documented bellow. )ABCabstractmethodabstractpropertyc@seZdZdZeddZeddZedZdd Zed d Z ed d Z eddZ eddZ eddZ ed[ddZeddZed\ddZeddZeddZeddZed d!Zd"d#Zed$d%Zed&d'Zed(d)Zed*d+Zed]d-d.Zed^d0d1Zed_d2d3Zed`d4d5Zed6d7Zed8d9Zed:d;Z edd?Z"edad@dAZ#dBdCZ$dDdEZ%dFdGZ&edHdIZ'edJdKZ(edLdMZ)edNdOZ*edPdQZ+edRdSZ,edbdTdUZ-edcdVdWZ.edddXdYZ/dS)eCryptoConnectora CryptoConnector class Represent an abstract API connector class. Attributes ---------- PLATFORM_ID: The database id of the platform. PLATFORM_NAME: The name of the platform. Methods ------- TODO: List mandatory methods. cCsdSNselfrrJ/var/www/html/myfo-crypto/python/myfo/crypto/connector/common/connector.py PLATFORM_IDszCryptoConnector.PLATFORM_IDcCsdSrrrrrr PLATFORM_NAME szCryptoConnector.PLATFORM_NAMEFNcCsdS)atCreate and returns the connector object. The connector is created from the user API keys. Parameters ---------- api_key : str The user API key for the exchange. api_secret : str The user API secret for the exchange. testnet : bool Either the connector shall use the testnet endpoints or not. Defaults to 'False'. user : myfo.crypto.common.user.UserNew The user associated to the connector. Defaults to None. Returns ------- CryptoConnector The CryptoConnector object instance. Nr)r api_key api_secrettestnetuserrrr __init__$szCryptoConnector.__init__cCsdS)zCheck whether is user has authorised the source IP address to connect to it's account. Returns ------- bool Whether the source IP is authorized or not. Nrrrrr is_ip_authorized<s z CryptoConnector.is_ip_authorizedcCsdS)zCheck whether the read permission is enabled for this connector. Returns ------- bool Whether the read permission is enabled or not. Nrrrrr has_read_permissionGs z#CryptoConnector.has_read_permissioncCsdS)zCheck whether the write permission is enabled for this connector. Returns ------- bool Whether the write permission is enabled or not. Nrrrrr has_write_permissionRs z$CryptoConnector.has_write_permissioncCsdS)zCheck whether the withdraw permission is enabled for this connector. Returns ------- bool Whether the withdraw permission is enabled or not. Nrrrrr has_withdraw_permission]s z'CryptoConnector.has_withdraw_permissioncCsdS)zCheck whether the user can trade future in platform. Returns ------- bool Whether the user can trade futures or not. Nrrrrr has_future_authorizedhs z%CryptoConnector.has_future_authorizedcCsdS)a'Retrieve balance on the exchange. The balance is returned for all supported currencies. Parameters ---------- as_usd : bool If True, balances will be shown in USD, otherwise into local currency. Defaults to False. Returns ------- dict The dict containing dicts of balance. Format ----- { : { "symbol": , "balance": , "available_balance": , "currency": , }, ... } Fields ------ : str The symbol of the asset. : float The total balance on the exchange. : float The available balance on the exchange. : str The currency in which balances are shown. Nr)r as_usdrrr get_balancess(zCryptoConnector.get_balancecCsdSrrrrrr get_profitszCryptoConnector.get_profitcCsdS)a Retrieve and returns all the available products on the exchange. All the products are saved into the self.products dictionnary for further access. Products are only retrieved once and then returned from the internal dictionnary. Parameters ---------- reload : bool If True, force reload of products from the exchange. Defaults to False. Returns ------- list The list containing dicts of products. Format ----- [ : { "symbol": , "exchange_id": , "exchange_symbol": , "contract_type": , "strike_price": , "settlement_date": , "settlement_time": , "duration": , "tick_size": , "contract_size": , "min_notional": , "base_asset_id": , "base_asset_symbol": , "quote_asset_id": , "quote_asset_symbol": , }, ... ] Fields ------ : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [spot|future|perpetual_future|call_option|put_option|move_option|spread|interest_rate_swap|staking] The type of the product. : float The strike price associated to the product. None if not applicable. : str The date at which the product expires as a string 'YYYY-MM-DD'. None if not applicable. : str The date and time at which the product expires as a string 'YYYY-MM-DDTHH:MM:SSZ'. None if not applicable. : int The number of days until expiration. None if not applicable. : float The minimum price change and thus, the number of decimals. : float The minimum contract size, when placing order, size must be a multiple of contract size. : float The minimum traded amount, when placing order, size*price must be greater than 'min_notional'. : int, str The identifier of the base asset on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the base asset on the exchange. : int, str The identifier of the quoting asset on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the quoting asset on the exchange. Nr)r reloadrrr get_productssPzCryptoConnector.get_productscCsdS)a Retrieve and returns the product identified by the given symbol. Parameters ---------- symbol : str The symbol of the product. Returns ------- dict The dictionnary describing the product. Format ----- { "symbol": , "exchange_id": , "exchange_symbol": , "contract_type": , "strike_price": , "settlement_date": , "settlement_time": , "tick_size": , "contract_size": , "base_asset_id": , "base_asset_symbol": , "quote_asset_id": , "quote_asset_symbol": , } Fields ------ : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [spot|future|perpetual_future|call_option|put_option|move_option|spread|interest_rate_swap] The type of the product. : float The strike price associated to the product. None if not applicable. : str The date at which the product expires as a string 'YYYY-MM-DD'. None if not applicable. : str The date and time at which the product expires as a string 'YYYY-MM-DDTHH:MM:SSZ'. None if not applicable. : float The minimum price change and thus, the number of decimals. : float The minimum contract size, when placing order, size must be a multiple of contract size. : int, str The identifier of the base asset on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the base asset on the exchange. : int, str The identifier of the quoting asset on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the quoting asset on the exchange. Nrr symbolrrr get_productsCzCryptoConnector.get_productcCsdS)a(Retrieve the mark_price of the given product. Parameters ---------- symbol : str The unique symbol used to identify the product. Returns ------- dict The dictionnary representing the orderbook. Format ------ { "buy": [ { "price": , "size": , }, ... ], "sell": [ { "price": , "size": , }, ... ], "symbol": } Fields ------ : float The product buy or sell price. : int The available size for the associated price. : str The symbol of the product associated to the orderbook. Nrrrrr get_orderbook9s+zCryptoConnector.get_orderbookcCsdS)aRetrieve the spot price associated to the given product. Parameters ---------- symbol : str The unique symbol used to identify the product. Returns ------- dict The dictionnary containing the spot_price. Format ------ { "symbol": , "exchange_id": , "exchange_symbol": , "spot_price": , } Fields ------ : str The symbol of the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : float The spot_price of the product. Nrrrrr get_spot_pricefs#zCryptoConnector.get_spot_pricecCsdS)aRetrieve the mark price associated to the given product. Parameters ---------- symbol : str The unique symbol used to identify the product. Returns ------- dict The dictionnary containing the mark_price. Format ------ { "symbol": , "exchange_id": , "exchange_symbol": , "mark_price": , } Fields ------ : str The symbol of the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : float The mark_price of the product. Nrrrrr get_mark_prices#zCryptoConnector.get_mark_pricecCsdS)a|Retrieve greeks associated to the given symbol. Parameters ---------- symbol : str The unique symbol used to identify the product. Returns ------- dict The dictionnary containing the greeks. Format ------ { "symbol": , "exchange_id": , "exchange_symbol": , "mark_price": , "delta": , "gamma": , "theta": , "rho": , "vega": , } Fields ------ : str The symbol of the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : float The delta of the product. : float The gamma of the product. : float The theta of the product. : float The rho of the product. : float The vega of the product. Nrrrrr get_greekss/zCryptoConnector.get_greekscCsdS)aRetrieve the current positions on the exchange. Returns ------- dict The dictionnary containing the positions. Format ------ { : { "symbol": , "exchange_id": , "exchange_symbol": , "size": , "entry_price": , "maintenance_margin": , "contract_type": , "base_asset_id": , "base_asset_symbol": , "quote_asset_id": , "quote_asset_symbol": , } ... } Fields ------ : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : float The position size. : float The maintenance margin associated to the position if applicable, otherwise set to 0. : Enum [spot|future|perpetual_future|call_option|put_option|move_option|spread|interest_rate_swap] The type of the product. : int, str The identifier of the base asset on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the base asset on the exchange. : int, str The identifier of the quoting asset on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the quoting asset on the exchange. Nrrrrr get_positionss6zCryptoConnector.get_positionscCsdS)anRetrieve the position information on the given product. Parameters ---------- symbol : str The unique symbol used to identify the product. Returns ------- dict The dictionnary containing the position information. Format ------ { "symbol": , "exchange_id": , "exchange_symbol": , "size": , "entry_price": , } Fields ------ : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : int The position size. : float The price at which the product has been traded. Nrrrrr get_positions&zCryptoConnector.get_positioncCsdS)a3Retrieve the current margin on the given product. Parameters ---------- symbol : str The unique symbol used to identify the product. Returns ------- dict The dictionnary containing the position margin. Format ------ { "symbol": , "exchange_id": , "exchange_symbol": , "auto_topup": , "margin": , "entry_price": , } Fields ------ : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : bool Whether the margin is auto-increased on margin call. None if not applicable. : float The margin amount on the position. : float The price at which the product has been traded. Nrrrrr get_position_marginCs*z#CryptoConnector.get_position_margincCsdS)aUpdate the margin on the given product. Parameters ---------- symbol : str The unique symbol used to identify the product. delta_margin: float The margin delta. Shall either be a positive number to add margin or a negative one to substract margin. Returns ------- dict The dictionnary containing the position margin. Format ------ { "symbol": , "exchange_id": , "exchange_symbol": , "auto_topup": , "margin": , "entry_price": , } Fields ------ : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : bool Whether the margin is auto-increased on margin call. None if not applicable. : float The updated margin amount on the position. : float The price at which the product has been traded. Nr)r r delta_marginrrr set_position_marginos-z#CryptoConnector.set_position_margingtccCsdS)a Place a market order. Parameters ---------- symbol : str The unique symbol used to identify the product. size: float The size of the order. Some sizes may be restricted depending on the exchange. side: str The side of the order, either 'buy' or 'sell'. time_in_force: str How the order should be executed. Defaults to 'gtc'. Possible values: gtc (Good Til Cancelled): The order remains active whatever part is filled. Or is manually cancelled by the user. fok (Fill or Kill): The order shall be entirely filled, otherwise it's cancelled. ioc (Immediate or Cancel): The order shall fill any possible part, unfilled part is cancelled. Returns ------- dict The dictionnary containing the position margin. Format ------ { "id": , "type": , "status": , "symbol": , "exchange_id": , "exchange_symbol": , "side": , "size": , "filled_size": , "unfilled_size": , "average_price": , "limit_price": , "stop_price": , "time_in_force": , "commission": , } Fields ------ : str The id of the order on the exchange. : Enum [market|limit|stop_market|stop_limit] The type of the order. : Enum [open|filled|partially_filled|cancelled] The status of the order. : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [buy|sell] The side of the order. : int The size of the order when oppened. : int The amount which has been filled. : int The amount which hasn't been filled. : float The average execution price. : float The price at which the order has been filled. None if not applicable. : float The price at which the order has been triggered. None if not applicable. : Enum [gtc|fok|ioc] How the order is executed. Refer to 'time_in_force' parameter. : float The commission taken by the exchange on this order. Nr)r rsizeside time_in_forcerrr place_market_ordersQz"CryptoConnector.place_market_orderrcCsdS)a Place a limit order. Parameters ---------- symbol : str The unique symbol used to identify the product. size: float The size of the order. Some sizes may be restricted depending on the exchange. side: str The side of the order, either 'buy' or 'sell'. limit_price: float The price at which the order shall be filled. time_in_force: str How the order should be executed. Defaults to 'gtc'. Possible values: gtc (Good Til Cancelled): The order remains active whatever part is filled. Or is manually cancelled by the user. fok (Fill or Kill): The order shall be entirely filled, otherwise it's cancelled. ioc (Immediate or Cancel): The order shall fill any possible part, unfilled part is cancelled. timeout: float The time to wait in seconds before cancelling order if not placed. If the timeout is zero or negative, the function won't wait for order execution. Returns ------- dict The dictionnary containing the position margin. Format ------ { "id": , "type": , "status": , "symbol": , "exchange_id": , "exchange_symbol": , "side": , "size": , "filled_size": , "unfilled_size": , "average_price": , "limit_price": , "stop_price": , "time_in_force": , "commission": , } Fields ------ : str The id of the order on the exchange. : Enum [market|limit|stop_market|stop_limit] The type of the order. : Enum [open|filled|partially_filled|cancelled] The status of the order. : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [buy|sell] The side of the order. : int The size of the order when oppened. : int The amount which has been filled. : int The amount which hasn't been filled. : float The average execution price. : float The price at which the order has been filled. None if not applicable. : float The price at which the order has been triggered. None if not applicable. : Enum [gtc|fok|ioc] How the order is executed. Refer to 'time_in_force' parameter. : float The commission taken by the exchange on this order. Nr)r rr)r* limit_pricer+timeoutrrr place_limit_ordersVz!CryptoConnector.place_limit_ordercCsdS)a Place a limit order. Parameters ---------- symbol : str The unique symbol used to identify the product. size: float The size of the order. Some sizes may be restricted depending on the exchange. side: str The side of the order, either 'buy' or 'sell'. stop_price: float The price at which the order shall be triggered. time_in_force: str How the order should be executed. Defaults to 'gtc'. Possible values: gtc (Good Til Cancelled): The order remains active whatever part is filled. Or is manually cancelled by the user. fok (Fill or Kill): The order shall be entirely filled, otherwise it's cancelled. ioc (Immediate or Cancel): The order shall fill any possible part, unfilled part is cancelled. Returns ------- dict The dictionnary containing the position margin. Format ------ { "id": , "type": , "status": , "symbol": , "exchange_id": , "exchange_symbol": , "side": , "size": , "filled_size": , "unfilled_size": , "average_price": , "limit_price": , "stop_price": , "time_in_force": , "commission": , } Fields ------ : str The id of the order on the exchange. : Enum [market|limit|stop_market|stop_limit] The type of the order. : Enum [open|filled|partially_filled|cancelled] The status of the order. : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [buy|sell] The side of the order. : int The size of the order when oppened. : int The amount which has been filled. : int The amount which hasn't been filled. : float The average execution price. : float The price at which the order has been filled. None if not applicable. : float The price at which the order has been triggered. None if not applicable. : Enum [gtc|fok|ioc] How the order is executed. Refer to 'time_in_force' parameter. : float The commission taken by the exchange on this order. Nr)r rr)r* stop_pricer+rrr place_stop_market_orderIsSz'CryptoConnector.place_stop_market_ordercCsdS)a+ Place a limit order. Parameters ---------- symbol : str The unique symbol used to identify the product. size: float The size of the order. Some sizes may be restricted depending on the exchange. side: str The side of the order, either 'buy' or 'sell'. stop_price: float The price at which the order shall be triggered. limit_price: float The price at which the order shall be filled. time_in_force: str How the order should be executed. Defaults to 'gtc'. Possible values: gtc (Good Til Cancelled): The order remains active whatever part is filled. Or is manually cancelled by the user. fok (Fill or Kill): The order shall be entirely filled, otherwise it's cancelled. ioc (Immediate or Cancel): The order shall fill any possible part, unfilled part is cancelled. Returns ------- dict The dictionnary containing the position margin. Format ------ { "id": , "type": , "status": , "symbol": , "exchange_id": , "exchange_symbol": , "side": , "size": , "filled_size": , "unfilled_size": , "average_price": , "limit_price": , "stop_price": , "time_in_force": , "commission": , } Fields ------ : str The id of the order on the exchange. : Enum [market|limit|stop_market|stop_limit] The type of the order. : Enum [open|filled|partially_filled|cancelled] The status of the order. : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [buy|sell] The side of the order. : int The size of the order when oppened. : int The amount which has been filled. : int The amount which hasn't been filled. : float The average execution price. : float The price at which the order has been filled. None if not applicable. : float The price at which the order has been triggered. None if not applicable. : Enum [gtc|fok|ioc] How the order is executed. Refer to 'time_in_force' parameter. : float The commission taken by the exchange on this order. Nr)r rr)r*r0r-r+rrr place_stop_limit_ordersUz&CryptoConnector.place_stop_limit_ordercCsdS)a Retrieve currently active orders on the given product. Parameters ---------- symbol : str The unique symbol used to identify the product. Returns ------- list The list containing the dictionnaries of orders. Format ------ [ { "id": , "type": , "status": , "symbol": , "exchange_id": , "exchange_symbol": , "side": , "size": , "filled_size": , "unfilled_size": , "average_price": , "limit_price": , "stop_price": , "time_in_force": , }, ... ] Fields ------ : str The id of the order on the exchange. : Enum [market|limit|stop_market|stop_limit] The type of the order. : Enum [open|filled|partially_filled|cancelled] The status of the order. : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [buy|sell] The order side, either 'buy' or 'sell'. : int The order size. : int The amount which has been filled. : int The amount which hasn't been filled. : float The average execution price. : float The price at which the order has been filled. None if not applicable. : float The price at which the order has been triggered. None if not applicable. : Enum [gtc|fok|ioc] How the order is executed. Refer to 'time_in_force' parameter. Nrrrrr get_active_orderssFz!CryptoConnector.get_active_orderscCsdS)a Cancel the given order on the given product. Parameters ---------- symbol : str The unique symbol used to identify the product. order_id : str The id of the order on the exchange. Returns ------- dict The dictionnary containing the order information. Format ------ { "id": , "type": , "status": , "symbol": , "exchange_id": , "exchange_symbol": , "side": , "size": , "filled_size": , "unfilled_size": , "average_price": , "limit_price": , "stop_price": , "time_in_force": , } Fields ------ : str The id of the order on the exchange. : Enum [market|limit|stop_market|stop_limit] The type of the order. : Enum [open|filled|partially_filled|cancelled] The status of the order. : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [buy|sell] The order side, either 'buy' or 'sell'. : int The order size. : int The amount which has been filled. : int The amount which hasn't been filled. : float The average execution price. : float The price at which the order has been filled. None if not applicable. : float The price at which the order has been triggered. None if not applicable. : Enum [gtc|fok|ioc] How the order is executed. Refer to 'time_in_force' parameter. Nr)r rorder_idrrr cancel_order=sEzCryptoConnector.cancel_ordercCsdS)a Returns the order history. Returns ------- list The list containing dictionnaries of orders. Format ------ [ { "created_at": , "updated_at": , "id": , "type": , "status": , "symbol": , "exchange_id": , "exchange_symbol": , "side": , "size": , "filled_size": , "unfilled_size": , "average_price": , "limit_price": , "stop_price": , "time_in_force": , "source": , "is_liquidation": , "cancellation_reason": , } ] Fields ------ : str The date and time at which the order has been created as a string 'YYYY-MM-DDTHH:MM:SSZ'. : str The date and time at which the order has been updated as a string 'YYYY-MM-DDTHH:MM:SSZ'. : str The id of the order on the exchange. : Enum [market|limit|stop_market|stop_limit] The type of the order. : Enum [open|filled|partially_filled|cancelled] The status of the order. : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [buy|sell] The order side, either 'buy' or 'sell'. : int The order size. : int The amount which has been filled. : int The amount which hasn't been filled. : float The average execution price. : float The price at which the order has been filled. None if not applicable. : float The price at which the order has been triggered. None if not applicable. : Enum [gtc|fok|ioc] How the order is executed. Refer to 'time_in_force' parameter. : Enum [api|web] The source from which the order has been done. None if the order has been automatically done. : bool Whether the order is a liquidation or not. : str The reason why order has been cancelled. None if not applicable. Nrrrrr get_order_historysQz!CryptoConnector.get_order_historycCsdS)aReturns the position leverage. Parameters ---------- symbol : str The symbol of the position to get the leverage from. Returns ------- dict The dict containing the position leverage. Format ------ [ { "symbol": , "leverage": , } ] Fields ------ : str The unique symbol used to identify the product. : int The positive integer representing the position leverage. Nrrrrr get_leverageszCryptoConnector.get_leveragecCsdS)aSet the position leverage. Parameters ---------- symbol : str The symbol of the position to set the leverage for. leverage : int The leverage value to set. Returns ------- dict The dict containing the new position leverage. Format ------ [ { "symbol": , "leverage": , } ] Fields ------ : str The unique symbol used to identify the product. : int The positive integer representing the position leverage. Nr)r rleveragerrr set_leverages zCryptoConnector.set_leveragecCsdS)aRetrieve deposit and withdraw history. Parameters ---------- start_date : datetime.date The starting date of the history. If not given the first day of the curent year date will be used. end_date : datetime.date The ending date of the history. If not given, today's date will be used. Returns ------- list The list containing deposits and withdraws. Format ------ [ { "date": , "type": , "source_symbol": , "source_amount": , "destination_symbol": , "destination_amount": , "fees": , "operation_id": , "wallet_address": , } ] Fields ------ : datetime.datetime The datetime at which the operation has been done. : Enum [deposit|withdraw] The type of the operation. : str The symbol of the source currency used for the operation. : float The amount of the source currency used for the operation. : str The symbol of the destination currency used for the operation. : float The amount of the destination currency used for the operation. : float The fees associated to the operation. : str The id of the operation on the exchange. : str The wallet_address used for the operation. Nr)r start_dateend_daterrr get_deposit_withdraw_historys5z,CryptoConnector.get_deposit_withdraw_historycCstd|jjddS)Nz3Method 'create_wallet_address' not implemented for connectorNotImplementedError __class____name__rrrr create_wallet_addressQsz%CryptoConnector.create_wallet_addresscCstd|jjddS)Nz0Method 'get_wallet_address' not implemented for r=r>rrrr get_wallet_addressUsz"CryptoConnector.get_wallet_addresscCstd|jjddS)Nz&Method 'withdraw' not implemented for r=r>)r ramountZaddressrrr withdrawYszCryptoConnector.withdrawcCsdS)zTells if the websocket connection with the exchange has been lost. Returns ------- bool Whether the websocket connection is lost or not. Nrrrrr is_connection_lost\s z"CryptoConnector.is_connection_lostcCsdS)zTells if the websocket connection with the exchange has been aborted. Meaning that no reconnction will be tried anymore. Returns ------- bool Whether the websocket connection is aborted or not. Nrrrrr is_connection_abortedgs z%CryptoConnector.is_connection_abortedcCsdS)zSet the timeout between two reconnection tries when connection is lost. Parameters ---------- timeout : int The timeout in seconds. Nr)r r.rrr set_reconnect_timeoutrs z%CryptoConnector.set_reconnect_timeoutcCsdS)aISet the datetime at which reconnection tries will be stopped. If not set, reconnections will be tried indefinitely. Parameters ---------- datetime : datetime.datetime The datetime at which reconnection tries will be stopped. Set to 'None' for infinite reconnection tries. Nr)r datetimerrr set_abortion_datetime}s z%CryptoConnector.set_abortion_datetimecCsdS)zSet whether websocket messages and events shall be shown or not. Returns ---------- bool Whether websocket messages and events shall be shown or not. Nr)r showrrr show_websocket_logss z#CryptoConnector.show_websocket_logscCsdS)zCleanup websocket if necessary. If channels are no longer subscribe calling this function will disconnect all the websockets. Nrrrrr cleanupszCryptoConnector.cleanupcCsdS)aSubscribe to orderbook updates through websocket. Parameters ---------- symbols : str or list The symbols to subscribe to. If given as string, considered as a single symbol, otherwise as a list of symbol. callback : function(connector, data) The callback called on orderbook update event. connector : CryptoConnector The connector from which the event has been triggered. data : dict The data associated to the triggered event. Format ------ { "symbol": , "buy": [ { "price": , "size": , }, ... ], "sell": [ { "price": , "size": , }, ... ], } Fields ------ : str The symbol of the product associated to the orderbook. : float The product buy or sell price. : int The available size for the associated price. Nrr symbolscallbackrrr subscribe_orderbooks-z#CryptoConnector.subscribe_orderbookcCsdS)aSubscribe to mark price updates through websocket. Parameters ---------- symbols : str or list The symbols to subscribe to. If given as string, considered as a single symbol, otherwise as a list of symbol. callback : function(connector, data) The callback called on mark price update event. connector : CryptoConnector The connector from which the event has been triggered. data : dict The data associated to the triggered event. Format ------ { "symbol": , "mark_price": , } Fields ------ : str The symbol of the product associated to the orderbook. : float The mark_price of the product. NrrNrrr subscribe_mark_pricesz$CryptoConnector.subscribe_mark_pricecCsdS)a Subscribe to order updates through websocket. Parameters ---------- symbols : str or list The symbols to subscribe to. If given as string, considered as a single symbol, otherwise as a list of symbol. callback : function(connector, data) The callback called on order update event. connector : CryptoConnector The connector from which the event has been triggered. data : dict The data associated to the triggered event. Format ------ { "id": , "type": , "status": , "symbol": , "exchange_id": , "exchange_symbol": , "side": , "size": , "filled_size": , "unfilled_size": , "average_price": , "limit_price": , "stop_price": , "time_in_force": , "commission": , } Fields ------ : str The id of the order on the exchange. : Enum [market|limit|stop_market|stop_limit] The type of the order. : Enum [open|filled|partially_filled|cancelled] The status of the order. : str The unique symbol used to identify the product. : int, str The identifier of the product on the exchange. Can be either an integer of a string depending on the exchange. : str The symbol of the product on the exchange. : Enum [buy|sell] The side of the order. : int The size of the order when oppened. : int The amount which has been filled. : int The amount which hasn't been filled. : float The average execution price. : float The price at which the order has been filled. None if not applicable. : float The price at which the order has been triggered. None if not applicable. : Enum [gtc|fok|ioc] How the order is executed. Refer to 'time_in_force' parameter. : float The commission taken by the exchange on this order. NrrNrrr subscribe_orderssHz CryptoConnector.subscribe_orders)FN)F)F)r()r(r)r()r()NN)N)N)N)0rA __module__ __qualname____doc__rr r rrrrrrrrrrrrr r!r"r#r$r%r'r,r/r1r2r3r5r6r7r9r<rBrCrErFrGrHrJrLrMrQrRrSrrrr r s         )  Q D , $ &1 7 ' + . R W T V G F R  ! 7       . rN)rVabcrrrrrrrr s