fix: Add cashflow property to PortfolioHistory model (#553)

The get_portfolio_history API returns an optional cashflow property, which is a mapping of activity type to cash flow amounts.
alpacahq · Jan 20, 2025 · 18e2403 · 18e2403
1 parent 88221cb
commit 18e2403
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/alpaca/trading/models.py b/alpaca/trading/models.py
@@ -294,6 +294,7 @@ class PortfolioHistory(BaseModel):
         profit_loss_pct (List[Optional[float]]): Profit/loss in percentage from the base value.
         base_value (float): Basis in dollar of the profit loss calculation.
         timeframe (str): Time window size of each data element.
+        cashflow (Dict[ActivityType, List[float]]): Cash flow amounts per activity type, if any.
     """
 
     timestamp: List[int]
@@ -302,6 +303,7 @@ class PortfolioHistory(BaseModel):
     profit_loss_pct: List[Optional[float]]
     base_value: float
     timeframe: str
+    cashflow: Dict[ActivityType, List[float]] = {}
 
 
 class Watchlist(ModelWithID):