Add a bunch of fields that appear in my flex queries on new types

.github/workflows/commit-ibflex.yml

@@ -8,16 +8,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8]
+        python-version: ["3.11", "3.12"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     # - name: Cache pip
-    #   uses: actions/cache@v2
+    #   uses: actions/cache@v4
     #   with:
     #     path: ~/.cache/pip  # This path is specific to Ubuntu
     #     # Look to see if there is a cache hit for the corresponding requirements file
@@ -29,5 +29,5 @@ jobs:
       run: pip install -r requirements-development.txt
     - name: Static analysis with mypy
       run: mypy ibflex tests
-    - name: Test with nose
-      run: nosetests -dsv --with-coverage --cover-package ibflex tests/*.py
+    - name: Test with pytest
+      run: pytest -v --cov=ibflex tests/

README.rst

@@ -2,6 +2,23 @@
 Python parser for Interactive Brokers Flex XML statements
 =========================================================
 
+**VENDORED PACKAGE NOTICE**
+---------------------------
+
+This is a vendored and enhanced version of the original ibflex library by Christopher Singley
+(https://github.com/csingley/ibflex). 
+
+This fork 
+   * includes additional data fields beyond the upstream version
+   * incorporates similar improvements from robcohen/ibflex2
+   * includes an opt-in mechanism to be tolerant against IBKR adding new but unimportant attributes on a regular basis. 
+
+The version number 
+includes a "+vroonhof.vendored" suffix to distinguish it from the original package.
+
+**ORGINAL README**
+------------------
+
 ``ibflex`` is a Python library for converting brokerage statement data in
 Interactive Brokers' Flex XML format into standard Python data structures,
 so it can be conveniently processed and analyzed with Python scripts.

ibflex/Types.py

@@ -90,6 +90,7 @@ class  decorator.  Class attributes are annotated with PEP 484 type hints.
     "SymbolSummary",
     "AssetSummary",
     "Order",
+    "StockGrantActivity",
 ]
 
 import datetime
@@ -187,7 +188,7 @@ class FlexStatement(FlexElement):
     ConversionRates: Tuple["ConversionRate", ...] = ()
     HKIPOOpenSubscriptions: Tuple = ()  # TODO
     CommissionCredits: Tuple = ()  # TODO
-    StockGrantActivities: Tuple = ()  # TODO
+    StockGrantActivities: Tuple["StockGrantActivity", ...] = ()
     SLBCollaterals: Tuple = ()  # TODO
     IncentiveCouponAccrualDetails: Tuple = ()  # TODO
     DepositsOnHold: Tuple = ()  # TODO
@@ -468,7 +469,6 @@ class EquitySummaryByReportDateInBase(FlexElement):
     physDel: Optional[decimal.Decimal] = None
     physDelLong: Optional[decimal.Decimal] = None
     physDelShort: Optional[decimal.Decimal] = None
-    currency: Optional[str] = None
     insuredBankDepositRedemptionCashComponentLong: Optional[decimal.Decimal] = None
     insuredBankDepositRedemptionCashComponentShort: Optional[decimal.Decimal] = None
     incentiveCouponAccrualsLong: Optional[decimal.Decimal] = None
@@ -479,6 +479,12 @@ class EquitySummaryByReportDateInBase(FlexElement):
     marginFinancingChargeAccrualsShort: Optional[decimal.Decimal] = None
     cryptoLong: Optional[decimal.Decimal] = None
     cryptoShort: Optional[decimal.Decimal] = None
+    liteSurchargeAccruals: Optional[decimal.Decimal] = None
+    liteSurchargeAccrualsLong: Optional[decimal.Decimal] = None
+    liteSurchargeAccrualsShort: Optional[decimal.Decimal] = None
+    cgtWithholdingAccruals: Optional[decimal.Decimal] = None
+    cgtWithholdingAccrualsLong: Optional[decimal.Decimal] = None
+    cgtWithholdingAccrualsShort: Optional[decimal.Decimal] = None
 
 
 @dataclass(frozen=True)
@@ -709,6 +715,8 @@ class CashReportCurrency(FlexElement):
     salesTaxYTD: Optional[decimal.Decimal] = None
     salesTaxPaxos: Optional[decimal.Decimal] = None
     otherIncome: Optional[decimal.Decimal] = None
+    otherIncomeMTD: Optional[decimal.Decimal] = None
+    otherIncomeYTD: Optional[decimal.Decimal] = None
     otherIncomeSec: Optional[decimal.Decimal] = None
     otherIncomeCom: Optional[decimal.Decimal] = None
     otherFeesMTD: Optional[decimal.Decimal] = None
@@ -1144,7 +1152,8 @@ class Trade(FlexElement):
     subCategory: Optional[str] = None
     issuerCountryCode: Optional[str] = None
     rtn: Optional[str] = None
-    initialInvestment: Optional[decimal.Decimal] = None
+    initialInvestment: Optional[bool] = None
+    positionActionID: Optional[str] = None
 
 
 @dataclass(frozen=True)
@@ -1296,7 +1305,8 @@ class Lot(FlexElement):
     issuerCountryCode: Optional[str] = None
     relatedTradeID: Optional[str] = None
     rtn: Optional[str] = None
-    initialInvestment: Optional[decimal.Decimal] = None
+    initialInvestment: Optional[bool] = None
+    positionActionID: Optional[str] = None
 
 
 @dataclass(frozen=True)
@@ -1385,19 +1395,29 @@ class SymbolSummary(FlexElement):
     tradeID: Optional[str] = None
     orderID: Optional[decimal.Decimal] = None
     execID: Optional[str] = None
+    ibExecID: Optional[str] = None
+    extExecID: Optional[str] = None
+    exchOrderId: Optional[str] = None
     brokerageOrderID: Optional[str] = None
     orderReference: Optional[str] = None
     volatilityOrderLink: Optional[str] = None
     clearingFirmID: Optional[str] = None
     origTradePrice: Optional[decimal.Decimal] = None
     origTradeDate: Optional[datetime.date] = None
     origTradeID: Optional[str] = None
+    transactionID: Optional[str] = None
     #  Despite the name, `orderTime` actually contains date/time data.
     orderTime: Optional[datetime.datetime] = None
+    openDateTime: Optional[datetime.datetime] = None
+    holdingPeriodDateTime: Optional[datetime.datetime] = None
     dateTime: Optional[datetime.datetime] = None
     reportDate: Optional[datetime.date] = None
     settleDate: Optional[datetime.date] = None
+    settleDateTarget: Optional[datetime.date] = None        # expected date of ownership transfer
+    taxes: Optional[decimal.Decimal] = None
     tradeDate: Optional[datetime.date] = None
+    tradePrice: Optional[decimal.Decimal] = None    
+    tradeMoney: Optional[decimal.Decimal] = None            # TradeMoney = Proceeds + Fees + Commissions
     exchange: Optional[str] = None
     buySell: Optional[enums.BuySell] = None
     quantity: Optional[decimal.Decimal] = None
@@ -1427,6 +1447,30 @@ class SymbolSummary(FlexElement):
     relatedTradeID: Optional[str] = None
     origTransactionID: Optional[str] = None
     relatedTransactionID: Optional[str] = None
+    positionActionID: Optional[str] = None
+    changeInPrice: Optional[decimal.Decimal] = None
+    changeInQuantity: Optional[decimal.Decimal] = None
+    closePrice: Optional[decimal.Decimal] = None
+    commodityType: Optional[str] = None
+    cost: Optional[decimal.Decimal] = None
+    deliveryType: Optional[str] = None
+    fifoPnlRealized: Optional[decimal.Decimal] = None
+    fineness: Optional[decimal.Decimal] = None
+    ibCommission: Optional[decimal.Decimal] = None
+    ibCommissionCurrency: Optional[str] = None
+    ibOrderID: Optional[str] = None
+    initialInvestment: Optional[bool] = None
+    mtmPnl: Optional[decimal.Decimal] = None
+    netCash: Optional[decimal.Decimal] = None
+    netCashInBase: Optional[decimal.Decimal] = None
+    notes: Optional[str] = None
+    openCloseIndicator: Optional[enums.OpenClose] = None
+    origOrderID: Optional[str] = None
+    rtn: Optional[str] = None
+    serialNumber: Optional[str] = None
+    weight: Optional[str] = None
+    whenRealized: Optional[datetime.datetime] = None
+    whenReopened: Optional[datetime.datetime] = None
 
 
 @dataclass(frozen=True)
@@ -1535,7 +1579,8 @@ class AssetSummary(FlexElement):
     origTransactionID: Optional[str] = None
     relatedTransactionID: Optional[str] = None
     rtn: Optional[str] = None
-    initialInvestment: Optional[decimal.Decimal] = None
+    initialInvestment: Optional[bool] = None
+    positionActionID: Optional[str] = None
 
 
 @dataclass(frozen=True)
@@ -1638,12 +1683,13 @@ class Order(FlexElement):
     origTransactionID: Optional[str] = None
     relatedTransactionID: Optional[str] = None
     rtn: Optional[str] = None
-    initialInvestment: Optional[decimal.Decimal] = None
+    initialInvestment: Optional[bool] = None
     serialNumber: Optional[str] = None
     deliveryType: Optional[str] = None
     commodityType: Optional[str] = None
     fineness: Optional[decimal.Decimal] = None
     weight: Optional[str] = None
+    positionActionID: Optional[str] = None
 
 
 @dataclass(frozen=True)
@@ -1796,7 +1842,7 @@ class OptionEAE(FlexElement):
     origTransactionID: Optional[str] = None
     relatedTransactionID: Optional[str] = None
     rtn: Optional[str] = None
-    initialInvestment: Optional[decimal.Decimal] = None
+    initialInvestment: Optional[bool] = None
     serialNumber: Optional[str] = None
     deliveryType: Optional[str] = None
     commodityType: Optional[str] = None
@@ -2122,7 +2168,12 @@ class Transfer(FlexElement):
     commodityType: Optional[str] = None
     fineness: Optional[decimal.Decimal] = None
     weight: Optional[str] = None
-
+    figi: Optional[str] = None
+    settleDate: Optional[datetime.date] = None
+    issuerCountryCode: Optional[str] = None
+    levelOfDetail: Optional[str] = None
+    positionInstructionID: Optional[str] = None
+    positionInstructionSetID: Optional[str] = None
 
 @dataclass(frozen=True)
 class UnsettledTransfer(FlexElement):
@@ -2245,6 +2296,11 @@ class CorporateAction(FlexElement):
     commodityType: Optional[str] = None
     fineness: Optional[decimal.Decimal] = None
     weight: Optional[str] = None
+    figi: Optional[str] = None
+    issuerCountryCode: Optional[str] = None
+    costBasis: Optional[decimal.Decimal] = None
+
+
 
 
 @dataclass(frozen=True)
@@ -2480,7 +2536,7 @@ class SecurityInfo(FlexElement):
     origTransactionID: Optional[str] = None
     relatedTransactionID: Optional[str] = None
     rtn: Optional[str] = None
-    initialInvestment: Optional[decimal.Decimal] = None
+    initialInvestment: Optional[bool] = None
     serialNumber: Optional[str] = None
     deliveryType: Optional[str] = None
     commodityType: Optional[str] = None
@@ -2819,5 +2875,49 @@ class SLBOpenContract(FlexElement):
     fineness: Optional[decimal.Decimal] = None
     weight: Optional[decimal.Decimal] = None
 
+
+@dataclass(frozen=True)
+class StockGrantActivity(FlexElement):
+    accountId: Optional[str] = None
+    acctAlias: Optional[str] = None
+    model: Optional[str] = None
+    currency: Optional[str] = None
+    fxRateToBase: Optional[decimal.Decimal] = None
+    assetCategory: Optional[enums.AssetClass] = None
+    subCategory: Optional[str] = None
+    symbol: Optional[str] = None
+    description: Optional[str] = None
+    conid: Optional[str] = None
+    securityID: Optional[str] = None
+    securityIDType: Optional[str] = None
+    cusip: Optional[str] = None
+    isin: Optional[str] = None
+    figi: Optional[str] = None
+    listingExchange: Optional[str] = None
+    underlyingConid: Optional[str] = None
+    underlyingSymbol: Optional[str] = None
+    underlyingSecurityID: Optional[str] = None
+    underlyingListingExchange: Optional[str] = None
+    issuer: Optional[str] = None
+    issuerCountryCode: Optional[str] = None
+    multiplier: Optional[decimal.Decimal] = None
+    strike: Optional[decimal.Decimal] = None
+    expiry: Optional[datetime.date] = None
+    putCall: Optional[enums.PutCall] = None
+    principalAdjustFactor: Optional[decimal.Decimal] = None
+    reportDate: Optional[datetime.date] = None
+    activityDescription: Optional[str] = None
+    awardDate: Optional[datetime.date] = None
+    vestingDate: Optional[datetime.date] = None
+    quantity: Optional[decimal.Decimal] = None
+    price: Optional[decimal.Decimal] = None
+    value: Optional[decimal.Decimal] = None
+    serialNumber: Optional[str] = None
+    deliveryType: Optional[str] = None
+    commodityType: Optional[str] = None
+    fineness: Optional[decimal.Decimal] = None
+    weight: Optional[decimal.Decimal] = None
+
+
 #  Type alias to work around https://github.com/python/mypy/issues/1775
 _ClientFeesDetail = ClientFeesDetail

ibflex/__init__.py

@@ -4,6 +4,8 @@
 from .Types import *
 from . import parser
 from .parser import parse
+from .parser import enable_unknown_attribute_tolerance
+from .parser import disable_unknown_attribute_tolerance
 from . import utils
 from . import client
 

ibflex/__version__.py

@@ -16,8 +16,8 @@
 __description__ = (
     "Parse Interactive Brokers Flex XML reports and convert to Python types"
 ),
-__url__ = "https://github.com/csingley/ibflex"
-__version__ = "0.16"
+__url__ = "https://github.com/vroonhof/ibflex"
+__version__ = "0.16+vroonhof.vendored"
 __author__ = "Christopher Singley"
 __author_email__ = "csingley@gmail.com"
 __license__ = "MIT"

ibflex/client.py

@@ -136,8 +136,6 @@ def request_statement(
     """First part of the 2-step download process.
     """
     url = url or REQUEST_URL
-    ### AKE FIX
-    url = 'https://ndcdyn.interactivebrokers.com/portal.flexweb/api/v1/flexQuery'
     response = submit_request(url, token, query=query_id)
     stmt_access = parse_stmt_response(response)
     if isinstance(stmt_access, StatementError):

ibflex/enums.py

@@ -77,6 +77,7 @@ class Code(str, enum.Enum):
     INVESTOR = "INV"  # Investment Transfer from Investor
     MARGINLOW = "L"  # Ordered by IB (Margin Violation)
     WASHSALE = "LD"  # Adjusted by Loss Disallowed from Wash Sale
+    LIQUIDATION_FORCED = "LF"  # Forced Liquidation
     LIFO = "LI"  # Last In, First Out (LIFO) tax lot-matching method
     LTCG = "LT"  # Long-term P/L
     LOAN = "Lo"  # Direct Loan
@@ -170,6 +171,7 @@ class OrderType(str, enum.Enum):
     TRAIL = "TRAIL"
     REL = "REL"
     MIT = "MIT"
+    LIT = "LIT"
 
 @enum.unique
 class Reorg(str, enum.Enum):
@@ -236,6 +238,7 @@ class TransferType(str, enum.Enum):
     ACATS = "ACATS"
     ATON = "ATON"
     FOP = "FOP"
+    OTC = "OTC"
 
 
 @enum.unique