Results object class. Results are exhaust from backtest or live algorithms running in LEAN More...
Properties | |
| string | Note [get, set] |
| Note on the backtest attached by the user More... | |
| bool | Completed [get, set] |
| Boolean true when the backtest is completed. More... | |
| int | OrganizationId [get, set] |
| Organization ID More... | |
| Dictionary< string, AlgorithmPerformance > | RollingWindow [get, set] |
| Rolling window detailed statistics. More... | |
| AlgorithmPerformance | TotalPerformance [get, set] |
| Total algorithm performance statistics. More... | |
| IDictionary< string, Chart > | Charts [get, set] |
| Charts updates for the live algorithm since the last result packet More... | |
| IDictionary< string, string > | Statistics [get, set] |
| Statistics information sent during the algorithm operations. More... | |
| IDictionary< string, string > | RuntimeStatistics [get, set] |
| Runtime banner/updating statistics in the title banner of the live algorithm GUI. More... | |
| ResearchGuide | ResearchGuide [get, set] |
| A power gauge for backtests, time and parameters to estimate the overfitting risk More... | |
| DateTime? | BacktestStart [get, set] |
| The starting time of the backtest More... | |
| DateTime? | BacktestEnd [get, set] |
| The ending time of the backtest More... | |
| bool | HasInitializeError [get, set] |
| Indicates if the backtest has error during initialization More... | |
| string | NodeName [get, set] |
| The backtest node name More... | |
| int | ProjectId [get, set] |
| The associated project id More... | |
| DateTime? | OutOfSampleMaxEndDate [get, set] |
| End date of out of sample data More... | |
| int? | OutOfSampleDays [get, set] |
| Number of days of out of sample days More... | |
 Properties inherited from QuantConnect.Api.BasicBacktest | |
| string | Error [get, set] |
| Backtest error message More... | |
| string | Stacktrace [get, set] |
| Backtest error stacktrace More... | |
| string | BacktestId [get, set] |
| Assigned backtest Id More... | |
| string | Status [get, set] |
| Status of the backtest More... | |
| string | Name [get, set] |
| Name of the backtest More... | |
| DateTime | Created [get, set] |
| Backtest creation date and time More... | |
| decimal | Progress [get, set] |
| Progress of the backtest in percent 0-1. More... | |
| string | OptimizationId [get, set] |
| Optimization task ID, if the backtest is part of an optimization More... | |
| int | TradeableDates [get, set] |
| Number of tradeable days More... | |
| ParameterSet | ParameterSet [get, set] |
| Optimization parameters More... | |
| int | SnapShotId [get, set] |
| Snapshot id of this backtest result More... | |
| Properties inherited from QuantConnect.Api.RestResponse | |
| bool | Success [get, set] |
| Indicate if the API request was successful. More... | |
| List< string > | Errors [get, set] |
| List of errors with the API call. More... | |
Additional Inherited Members | |
| Public Member Functions inherited from QuantConnect.Api.RestResponse | |
| RestResponse () | |
| JSON Constructor More... | |
| Public Member Functions inherited from QuantConnect.Api.StringRepresentation | |
| override string | ToString () |
| Returns the string representation of this object More... | |
Detailed Description
Results object class. Results are exhaust from backtest or live algorithms running in LEAN
Definition at line 116 of file Backtest.cs.
Property Documentation
◆ Note
|
getset |
Note on the backtest attached by the user
Definition at line 121 of file Backtest.cs.
◆ Completed
|
getset |
Boolean true when the backtest is completed.
Definition at line 126 of file Backtest.cs.
◆ OrganizationId
|
getset |
Organization ID
Definition at line 131 of file Backtest.cs.
◆ RollingWindow
|
getset |
Rolling window detailed statistics.
Definition at line 137 of file Backtest.cs.
◆ TotalPerformance
|
getset |
Total algorithm performance statistics.
Definition at line 143 of file Backtest.cs.
◆ Charts
|
getset |
Charts updates for the live algorithm since the last result packet
Definition at line 149 of file Backtest.cs.
◆ Statistics
|
getset |
Statistics information sent during the algorithm operations.
Intended for update mode – send updates to the existing statistics in the result GUI. If statistic key does not exist in GUI, create it
Definition at line 156 of file Backtest.cs.
◆ RuntimeStatistics
|
getset |
Runtime banner/updating statistics in the title banner of the live algorithm GUI.
Definition at line 162 of file Backtest.cs.
◆ ResearchGuide
|
getset |
A power gauge for backtests, time and parameters to estimate the overfitting risk
Definition at line 167 of file Backtest.cs.
◆ BacktestStart
|
getset |
The starting time of the backtest
Definition at line 172 of file Backtest.cs.
◆ BacktestEnd
|
getset |
The ending time of the backtest
Definition at line 177 of file Backtest.cs.
◆ HasInitializeError
|
getset |
Indicates if the backtest has error during initialization
Definition at line 182 of file Backtest.cs.
◆ NodeName
|
getset |
The backtest node name
Definition at line 187 of file Backtest.cs.
◆ ProjectId
|
getset |
The associated project id
Definition at line 192 of file Backtest.cs.
◆ OutOfSampleMaxEndDate
|
getset |
End date of out of sample data
Definition at line 197 of file Backtest.cs.
◆ OutOfSampleDays
|
getset |
Number of days of out of sample days
Definition at line 202 of file Backtest.cs.
The documentation for this class was generated from the following file:
- Common/Api/Backtest.cs
