bbstrader 0.3.1__py3-none-any.whl → 0.3.3__py3-none-any.whl

bbstrader/metatrader/account.py

@@ -1,12 +1,10 @@
 import os
 import re
 import urllib.request
-from datetime import datetime
+from datetime import datetime, timedelta
 from typing import Any, Dict, List, Literal, Optional, Tuple, Union
 
 import pandas as pd
-from currency_converter import SINGLE_DAY_ECB_URL, CurrencyConverter
-
 from bbstrader.metatrader.utils import (
     AccountInfo,
     BookInfo,
@@ -23,6 +21,7 @@ from bbstrader.metatrader.utils import (
     TradeRequest,
     raise_mt5_error,
 )
+from currency_converter import SINGLE_DAY_ECB_URL, CurrencyConverter
 
 try:
     import MetaTrader5 as mt5
@@ -33,6 +32,7 @@ except ImportError:
 __all__ = [
     "Account",
     "Broker",
+    "MetaQuotes",
     "AdmiralMarktsGroup",
     "JustGlobalMarkets",
     "PepperstoneGroupLimited",
@@ -41,6 +41,7 @@ __all__ = [
 ]
 
 __BROKERS__ = {
+    "MQL": "MetaQuotes Ltd.",
     "AMG": "Admirals Group AS",
     "JGM": "Just Global Markets Ltd.",
     "FTMO": "FTMO S.R.O.",
@@ -54,9 +55,7 @@ BROKERS_TIMEZONES = {
     "PGL": "Europe/Helsinki",
 }
 
-_ADMIRAL_MARKETS_URL_ = (
-    "https://cabinet.a-partnership.com/visit/?bta=35537&brand=admiralmarkets"
-)
+_ADMIRAL_MARKETS_URL_ = "https://one.justmarkets.link/a/tufvj0xugm/registration/trader"
 _JUST_MARKETS_URL_ = "https://one.justmarkets.link/a/tufvj0xugm/registration/trader"
 _FTMO_URL_ = "https://trader.ftmo.com/?affiliates=JGmeuQqepAZLMcdOEQRp"
 _ADMIRAL_MARKETS_PRODUCTS_ = [
@@ -69,14 +68,13 @@ _ADMIRAL_MARKETS_PRODUCTS_ = [
 ]
 _JUST_MARKETS_PRODUCTS_ = ["Stocks", "Crypto", "indices", "Commodities", "Forex"]
 
-SUPPORTED_BROKERS = [__BROKERS__[b] for b in {"AMG", "JGM", "FTMO"}]
+SUPPORTED_BROKERS = [__BROKERS__[b] for b in {"MQL", "AMG", "JGM", "FTMO"}]
 INIT_MSG = (
-    f"\n* Ensure you have a good and stable internet connexion\n"
-    f"* Ensure you have an activete MT5 terminal install on your machine\n"
-    f"* Ensure you have an active MT5 Account with {' or '.join(SUPPORTED_BROKERS)}\n"
-    f"* If you want to trade {', '.join(_ADMIRAL_MARKETS_PRODUCTS_)}, See [{_ADMIRAL_MARKETS_URL_}]\n"
-    f"* If you want to trade {', '.join(_JUST_MARKETS_PRODUCTS_)}, See [{_JUST_MARKETS_URL_}]\n"
-    f"* If you are looking for a prop firm, See [{_FTMO_URL_}]\n"
+    f"\n* Check your internet connection\n"
+    f"* Make sure MT5 is installed and active\n"
+    f"* Looking for a boker? See [{_ADMIRAL_MARKETS_URL_}] "
+    f"or [{_JUST_MARKETS_URL_}]\n"
+    f"* Looking for a prop firm? See [{_FTMO_URL_}]\n"
 )
 
 amg_url = _ADMIRAL_MARKETS_URL_
@@ -138,13 +136,22 @@ AMG_EXCHANGES = {
 }
 
 
-def check_mt5_connection(**kwargs):
+def check_mt5_connection(
+    *,
+    path=None,
+    login=None,
+    password=None,
+    server=None,
+    timeout=60_000,
+    portable=False,
+    **kwargs,
+) -> bool:
     """
     Initialize the connection to the MetaTrader 5 terminal.
 
     Args:
         path (str, optional): The path to the MetaTrader 5 terminal executable file.
-            Defaults to None (e.g., "C:\\Program Files\\MetaTrader 5\\terminal64.exe").
+            Defaults to None (e.g., "C:/Program Files/MetaTrader 5/terminal64.exe").
         login (int, optional): The login ID of the trading account. Defaults to None.
         password (str, optional): The password of the trading account. Defaults to None.
         server (str, optional): The name of the trade server to which the client terminal is connected.
@@ -158,13 +165,13 @@ def check_mt5_connection(**kwargs):
         - Follow these instructions to lunch each terminal in portable mode first:
             https://www.metatrader5.com/en/terminal/help/start_advanced/start#configuration_file
     """
-    path = kwargs.get("path", None)
-    login = kwargs.get("login", None)
-    password = kwargs.get("password", None)
-    server = kwargs.get("server", None)
-    timeout = kwargs.get("timeout", 60_000)
-    portable = kwargs.get("portable", False)
-
+    if login is not None and server is not None:
+        account_info = mt5.account_info()
+        if account_info is not None:
+            if account_info.login == login and account_info.server == server:
+                return True
+        
+    init = False
     if path is None and (login or password or server):
         raise ValueError(
             "You must provide a path to the terminal executable file"
@@ -189,6 +196,7 @@ def check_mt5_connection(**kwargs):
             raise_mt5_error(INIT_MSG)
     except Exception:
         raise_mt5_error(INIT_MSG)
+    return init
 
 
 def shutdown_mt5():
@@ -221,6 +229,11 @@ class Broker(object):
         return f"{self.__class__.__name__}({self.name})"
 
 
+class MetaQuotes(Broker):
+    def __init__(self, **kwargs):
+        super().__init__(__BROKERS__["MQL"], **kwargs)
+
+
 class AdmiralMarktsGroup(Broker):
     def __init__(self, **kwargs):
         super().__init__(__BROKERS__["AMG"], **kwargs)
@@ -262,6 +275,7 @@ class AMP(Broker): ...
 
 BROKERS: Dict[str, Broker] = {
     "FTMO": FTMO(),
+    "MQL": MetaQuotes(),
     "AMG": AdmiralMarktsGroup(),
     "JGM": JustGlobalMarkets(),
     "PGL": PepperstoneGroupLimited(),
@@ -391,6 +405,7 @@ class Account(object):
         password: Optional[str] = None,
         server: Optional[str] = None,
         timeout: Optional[int] = 60_000,
+        path: Optional[str] = None,
     ) -> Union[AccountInfo, None]:
         """
         Get info on the current trading account or a specific account .
@@ -408,6 +423,8 @@ class Account(object):
                  If not specified, the value of 60 000 (60 seconds) is applied.
                  If the connection is not established within the specified time,
                  the call is forcibly terminated and the exception is generated.
+            path (str, optional): The path to the MetaTrader 5 terminal executable file.
+                Defaults to None (e.g., "C:/Program Files/MetaTrader 5/terminal64.exe").
 
         Returns:
         -   AccountInfo in the form of a Namedtuple structure.
@@ -419,6 +436,15 @@ class Account(object):
         # connect to the trade account specifying a password and a server
         if account is not None and password is not None and server is not None:
             try:
+                # If a path is provided, initialize the MT5 terminal with it
+                if path is not None:
+                    check_mt5_connection(
+                        path=path,
+                        login=account,
+                        password=password,
+                        server=server,
+                        timeout=timeout,
+                    )
                 authorized = mt5.login(
                     account, password=password, server=server, timeout=timeout
                 )
@@ -1079,6 +1105,39 @@ class Account(object):
         except Exception as e:
             raise_mt5_error(e)
 
+    def calculate_profit(
+        self,
+        action: Literal["buy", "sell"],
+        symbol: str,
+        lot: float,
+        price_open: float,
+        price_close: float,
+    ) -> float:
+        """
+        Calculate profit in the account currency for a specified trading operation.
+
+        Args:
+            action (str): The trading action, either 'buy' or 'sell'.
+            symbol (str): The symbol of the financial instrument.
+            lot (float): The lot size of the order.
+            price_open (float): The price at which to position was opened.
+            price_close (float): The price at which to position was closed.
+
+        Returns:
+            float: The profit value
+
+        Raises:
+            MT5TerminalError: A specific exception based on the error code.
+
+        """
+        actions = {"buy": mt5.ORDER_TYPE_BUY, "sell": mt5.ORDER_TYPE_SELL}
+        try:
+            return mt5.order_calc_profit(
+                actions[action], symbol, lot, price_open, price_close
+            )
+        except Exception as e:
+            raise_mt5_error(e)
+
     def check_order(self, request: Dict[str, Any]) -> OrderCheckResult:
         """
         Check funds sufficiency for performing a required trading operation.
@@ -1327,7 +1386,7 @@ class Account(object):
         group: Optional[str] = None,
         ticket: Optional[int] = None,
         to_df: bool = False,
-    ) -> Union[pd.DataFrame, Tuple[TradeOrder], None]:
+    ) -> Union[pd.DataFrame, Tuple[TradeOrder]]:
         """
         Get active orders with the ability to filter by symbol or ticket.
         There are four call options:
@@ -1527,3 +1586,29 @@ class Account(object):
         else:
             history_orders = [TradeOrder(**td._asdict()) for td in history_orders]
             return tuple(history_orders)
+
+    def get_today_deals(self, id, group=None) -> List[TradeDeal]:
+        """
+        Get all today deals for a specific symbol or group of symbols
+
+        Args:
+            id (int): strategy or expert id
+            group (str): Symbol or group or symbol
+        Returns:
+            List[TradeDeal]: List of today deals
+        """
+        date_from = datetime.now() - timedelta(days=2)
+        history = (
+            self.get_trades_history(date_from=date_from, group=group, to_df=False) or []
+        )
+        positions_ids = set([deal.position_id for deal in history if deal.magic == id])
+        today_deals = []
+        for position in positions_ids:
+            deal = self.get_trades_history(
+                date_from=date_from, position=position, to_df=False
+            )
+            if deal is not None and len(deal) == 2:
+                deal_time = datetime.fromtimestamp(deal[1].time)
+                if deal_time.date() == datetime.now().date():
+                    today_deals.append(deal[1])
+        return today_deals