Portfolio
Holdings
Properties
SecurityHolding
objects have the following properties:
var securityHolding = Portfolio["SPY"]; var quantity = securityHolding.Quantity; var invested = securityHolding.Invested;
security_holding = self.portfolio["SPY"] quantity = security_holding.quantity invested = security_holding.invested
FutureHolding
objects also have SettledProfit
settled_profit
and UnsettledProfit
unsettled_profit
properties.
Get Total Close Profit
To get the profit of a position holding if you closed the position, call the TotalCloseProfit
total_close_profit
method. The value this method returns is denominated in your account currency and accounts for order fees.
var profit = Portfolio["SPY"].TotalCloseProfit();
profit = self.portfolio["SPY"].total_close_profit()
The TotalCloseProfit
total_close_profit
method accepts the following optional arguments:
Argument | Data Type | Description | Default Value |
---|---|---|---|
includeFees include_fees | bool | Whether to reduce the profit based on the estimated fee from the fee model. | true True |
exitPrice exit_price | decimal? float/NoneType | A hypothetical exit price to use for the profit calculation. If you don't provide a value, it uses the bid price for sell orders or the ask price for buy orders. | null None |
entryPrice entry_price | decimal? float/NoneType | A hypothetical exit price to use for the profit calculation. If you don't provide a value, it uses the average price of the SecurityHolding . | null None |
quantity | decimal? float/NoneType | The quantity to liquidate. If you don't provide a value, it uses the quantity of the SecurityHolding . | null None |
LEAN uses this method to define the UnrealizedProfit
unrealized_profit
property.
Get Quantity Value
To get the value of a security at any quantity, call the GetQuantityValue
get_quantity_value
method. The value this method returns is denominated in your account currency.
// Get the quantity value at the current price var valueAtCurrentPrice = Portfolio["SPY"].GetQuantityValue(100); // Get the quantity value at a specific price var valueAtSpecificPrice = Portfolio["SPY"].GetQuantityValue(100, price: 30);
# Get the quantity value at the current price value_at_current_price = self.portfolio["SPY"].get_quantity_value(100) # Get the quantity value at a specific price value_at_specific_price = self.portfolio["SPY"].get_quantity_value(100, price=30)