firstrade 0.0.33__py3-none-any.whl → 0.0.35__py3-none-any.whl

firstrade/account.py

@@ -8,6 +8,7 @@ import requests
 from firstrade import urls
 from firstrade.exceptions import (
     AccountResponseError,
+    LoginError,
     LoginRequestError,
     LoginResponseError,
 )
@@ -244,12 +245,14 @@ class FTSession:
                             "recipientId": item["recipientId"],
                             "t_token": self.t_token,
                         }
+                        break
                 elif item["channel"] == "email" and self.email is not None:
                     if self.email == item["recipientMask"]:
                         data = {
                             "recipientId": item["recipientId"],
                             "t_token": self.t_token,
                         }
+                        break
             response = self.session.post(urls.request_code(), data=data)
         elif self.login_json["mfa"] and self.mfa_secret is not None:
             mfa_otp = pyotp.TOTP(self.mfa_secret).now()
@@ -259,6 +262,11 @@ class FTSession:
                 "t_token": self.t_token,
             }
             response = self.session.post(urls.verify_pin(), data=data)
+        else:
+            raise LoginError(
+                "MFA required but no valid MFA method "
+                "was provided (pin, email/phone, or mfa_secret)."
+            )
         self.login_json = response.json()
         if self.login_json["error"] == "":
             if self.pin or self.mfa_secret is not None:
@@ -385,3 +393,52 @@ class FTAccountData:
 
         response = self.session.post(url=urls.cancel_order(), data=data)
         return response.json()
+
+    def get_balance_overview(self, account, keywords=None):
+        """
+        Returns a filtered, flattened view of useful balance fields.
+
+        This is a convenience helper over `get_account_balances` to quickly
+        surface likely relevant numbers such as cash, available cash, and
+        buying power without needing to know the exact response structure.
+
+        Args:
+            account (str): Account number to query balances for.
+            keywords (list[str], optional): Additional case-insensitive substrings
+                to match in keys. Defaults to a sensible set for balances.
+
+        Returns:
+            dict: A dict mapping dot-notated keys to values from the balances
+                  response where the key path contains any of the keywords.
+        """
+        if keywords is None:
+            keywords = [
+                "cash",
+                "avail",
+                "withdraw",
+                "buying",
+                "bp",
+                "equity",
+                "value",
+                "margin",
+            ]
+
+        payload = self.get_account_balances(account)
+
+        filtered = {}
+
+        def _walk(node, path):
+            if isinstance(node, dict):
+                for k, v in node.items():
+                    _walk(v, path + [str(k)])
+            elif isinstance(node, list):
+                for i, v in enumerate(node):
+                    _walk(v, path + [str(i)])
+            else:
+                key_path = ".".join(path)
+                low = key_path.lower()
+                if any(sub in low for sub in keywords):
+                    filtered[key_path] = node
+
+        _walk(payload, [])
+        return filtered

{firstrade-0.0.33.dist-info → firstrade-0.0.35.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: firstrade
-Version: 0.0.33
+Version: 0.0.35
 Summary: An unofficial API for Firstrade
 Home-page: https://github.com/MaxxRK/firstrade-api
-Download-URL: https://github.com/MaxxRK/firstrade-api/archive/refs/tags/0033.tar.gz
+Download-URL: https://github.com/MaxxRK/firstrade-api/archive/refs/tags/0035.tar.gz
 Author: MaxxRK
 Author-email: maxxrk@pm.me
 License: MIT
@@ -13,8 +13,6 @@ Classifier: Intended Audience :: Developers
 Classifier: Topic :: Internet :: WWW/HTTP :: Session
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -22,8 +20,7 @@ Classifier: Programming Language :: Python :: 3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
-Requires-Dist: beautifulsoup4
-Requires-Dist: lxml
+Requires-Dist: pyotp
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{firstrade-0.0.33.dist-info → firstrade-0.0.35.dist-info}/RECORD

@@ -1,11 +1,11 @@
 firstrade/__init__.py,sha256=fNiWYgSTjElY1MNv0Ug-sVLMTR2z_Ngri_FY7Pekdrw,95
-firstrade/account.py,sha256=wLPlQOzgaaBwb8tvYPcWdhfTtaUEtM54iPBl5dPpVHY,14129
+firstrade/account.py,sha256=1SMh3fopaHJnyTtHFsbuHXihz7qqv9m8OReDZ3rk-XM,16066
 firstrade/exceptions.py,sha256=OrWB83rc33LSxrI7WxXo4o7FcIfmvPSC9bAY8K1pn7U,1886
 firstrade/order.py,sha256=_b1SnqagwBu7KUmvzSUcp8iMOC3I3k-QDjiDLhlVk7E,8710
 firstrade/symbols.py,sha256=RH36QLx5v3rKPpBidyJFwGJSDkF5u5f2ILTSZNAGXGQ,7903
 firstrade/urls.py,sha256=Iw10isyvoqKwiSl3TVuIbos5INZzIEwpln3HcZ7P5aw,2125
-firstrade-0.0.33.dist-info/licenses/LICENSE,sha256=wPEQjDqm5zMBmEcZp219Labmq_YIjhudpZiUzyVKaFA,1057
-firstrade-0.0.33.dist-info/METADATA,sha256=P5nB38P3U45tTO7kSbuPhuBYUb5DVfXEVcSPKxl55sQ,3367
-firstrade-0.0.33.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-firstrade-0.0.33.dist-info/top_level.txt,sha256=tdA8v-KDxU1u4VV6soiNWGBlni4ojv_t_j2wFn5nZcs,10
-firstrade-0.0.33.dist-info/RECORD,,
+firstrade-0.0.35.dist-info/licenses/LICENSE,sha256=wPEQjDqm5zMBmEcZp219Labmq_YIjhudpZiUzyVKaFA,1057
+firstrade-0.0.35.dist-info/METADATA,sha256=6nQJDoEBpQBlai_7wzwZiWMqm5r8VWMoL21_2mNdH8M,3238
+firstrade-0.0.35.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+firstrade-0.0.35.dist-info/top_level.txt,sha256=tdA8v-KDxU1u4VV6soiNWGBlni4ojv_t_j2wFn5nZcs,10
+firstrade-0.0.35.dist-info/RECORD,,

{firstrade-0.0.33.dist-info → firstrade-0.0.35.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any