Lean  $LEAN_TAG$
QuantConnect.Report.PortfolioLooper Class Reference

Runs LEAN to calculate the portfolio at a given time from Order objects. Generates and returns PointInTimePortfolio objects that represents the holdings and other miscellaneous metrics at a point in time by reprocessing the orders as they were filled. More...

Inheritance diagram for QuantConnect.Report.PortfolioLooper:
[legend]

Public Member Functions

void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 

Static Public Member Functions

static IEnumerable< SliceGetHistory (List< Symbol > symbols, DateTime start, DateTime end, Resolution resolution)
 Gets the history for the given symbols from the start to the end More...
 
static IEnumerable< PointInTimePortfolioFromOrders (Series< DateTime, double > equityCurve, IEnumerable< Order > orders, AlgorithmConfiguration algorithmConfiguration=null, bool liveSeries=false)
 Gets the point in time portfolio over multiple deployments More...
 

Properties

PortfolioLooperAlgorithm Algorithm [get, protected set]
 QCAlgorithm derived class that sets up internal data feeds for use with crypto and forex data, as well as managing the SecurityPortfolioManager More...
 

Detailed Description

Runs LEAN to calculate the portfolio at a given time from Order objects. Generates and returns PointInTimePortfolio objects that represents the holdings and other miscellaneous metrics at a point in time by reprocessing the orders as they were filled.

Definition at line 43 of file PortfolioLooper.cs.

Member Function Documentation

◆ Dispose()

void QuantConnect.Report.PortfolioLooper.Dispose ( )

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Definition at line 158 of file PortfolioLooper.cs.

Here is the call graph for this function:

◆ GetHistory()

static IEnumerable<Slice> QuantConnect.Report.PortfolioLooper.GetHistory ( List< Symbol symbols,
DateTime  start,
DateTime  end,
Resolution  resolution 
)
static

Gets the history for the given symbols from the start to the end

Parameters
symbolsSymbols to request history for
startStart date of history request
endEnd date of history request
resolutionResolution of history request
Returns
Enumerable of slices

Definition at line 217 of file PortfolioLooper.cs.

◆ FromOrders()

static IEnumerable<PointInTimePortfolio> QuantConnect.Report.PortfolioLooper.FromOrders ( Series< DateTime, double >  equityCurve,
IEnumerable< Order orders,
AlgorithmConfiguration  algorithmConfiguration = null,
bool  liveSeries = false 
)
static

Gets the point in time portfolio over multiple deployments

Parameters
equityCurveEquity curve series
ordersOrders
algorithmConfigurationOptional parameter to override default algorithm configuration
liveSeriesEquity curve series originates from LiveResult
Returns
Enumerable of PointInTimePortfolio

Definition at line 243 of file PortfolioLooper.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

Property Documentation

◆ Algorithm

PortfolioLooperAlgorithm QuantConnect.Report.PortfolioLooper.Algorithm
getprotected set

QCAlgorithm derived class that sets up internal data feeds for use with crypto and forex data, as well as managing the SecurityPortfolioManager

Definition at line 60 of file PortfolioLooper.cs.


The documentation for this class was generated from the following file: