Lean  $LEAN_TAG$
QuantConnect.Api.LiveAlgorithmResults Class Reference

Details a live algorithm from the "live/read" Api endpoint More...

Inheritance diagram for QuantConnect.Api.LiveAlgorithmResults:
[legend]

Properties

string Message [get, set]
 Error message More...
 
string Status [get, set]
 Indicates the status of the algorihtm, i.e. 'Running', 'Stopped' More...
 
string DeployId [get, set]
 Algorithm deployment ID More...
 
int CloneId [get, set]
 The snapshot project ID for cloning the live development's source code. More...
 
DateTime Launched [get, set]
 Date the live algorithm was launched More...
 
DateTime? Stopped [get, set]
 Date the live algorithm was stopped More...
 
string Brokerage [get, set]
 Brokerage used in the live algorithm More...
 
string SecurityTypes [get, set]
 Security types present in the live algorithm More...
 
string ProjectName [get, set]
 Name of the project the live algorithm is in More...
 
string Datacenter [get, set]
 Name of the data center where the algorithm is physically located. More...
 
bool Public [get, set]
 Indicates if the algorithm is being live shared More...
 
List< ProjectFileFiles [get, set]
 Files present in the project in which the algorithm is More...
 
IDictionary< string, string > RuntimeStatistics [get, set]
 Runtime banner/updating statistics in the title banner of the live algorithm GUI. More...
 
IDictionary< string, ChartCharts [get, set]
 Charts updates for the live algorithm since the last result packet 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

Details a live algorithm from the "live/read" Api endpoint

Definition at line 27 of file LiveAlgorithmResults.cs.

Property Documentation

◆ Message

string QuantConnect.Api.LiveAlgorithmResults.Message
getset

Error message

Definition at line 32 of file LiveAlgorithmResults.cs.

◆ Status

string QuantConnect.Api.LiveAlgorithmResults.Status
getset

Indicates the status of the algorihtm, i.e. 'Running', 'Stopped'

Definition at line 37 of file LiveAlgorithmResults.cs.

◆ DeployId

string QuantConnect.Api.LiveAlgorithmResults.DeployId
getset

Algorithm deployment ID

Definition at line 42 of file LiveAlgorithmResults.cs.

◆ CloneId

int QuantConnect.Api.LiveAlgorithmResults.CloneId
getset

The snapshot project ID for cloning the live development's source code.

Definition at line 47 of file LiveAlgorithmResults.cs.

◆ Launched

DateTime QuantConnect.Api.LiveAlgorithmResults.Launched
getset

Date the live algorithm was launched

Definition at line 52 of file LiveAlgorithmResults.cs.

◆ Stopped

DateTime? QuantConnect.Api.LiveAlgorithmResults.Stopped
getset

Date the live algorithm was stopped

Definition at line 57 of file LiveAlgorithmResults.cs.

◆ Brokerage

string QuantConnect.Api.LiveAlgorithmResults.Brokerage
getset

Brokerage used in the live algorithm

Definition at line 62 of file LiveAlgorithmResults.cs.

◆ SecurityTypes

string QuantConnect.Api.LiveAlgorithmResults.SecurityTypes
getset

Security types present in the live algorithm

Definition at line 67 of file LiveAlgorithmResults.cs.

◆ ProjectName

string QuantConnect.Api.LiveAlgorithmResults.ProjectName
getset

Name of the project the live algorithm is in

Definition at line 72 of file LiveAlgorithmResults.cs.

◆ Datacenter

string QuantConnect.Api.LiveAlgorithmResults.Datacenter
getset

Name of the data center where the algorithm is physically located.

Definition at line 77 of file LiveAlgorithmResults.cs.

◆ Public

bool QuantConnect.Api.LiveAlgorithmResults.Public
getset

Indicates if the algorithm is being live shared

Definition at line 82 of file LiveAlgorithmResults.cs.

◆ Files

List<ProjectFile> QuantConnect.Api.LiveAlgorithmResults.Files
getset

Files present in the project in which the algorithm is

Definition at line 87 of file LiveAlgorithmResults.cs.

◆ RuntimeStatistics

IDictionary<string, string> QuantConnect.Api.LiveAlgorithmResults.RuntimeStatistics
getset

Runtime banner/updating statistics in the title banner of the live algorithm GUI.

Definition at line 93 of file LiveAlgorithmResults.cs.

◆ Charts

IDictionary<string, Chart> QuantConnect.Api.LiveAlgorithmResults.Charts
getset

Charts updates for the live algorithm since the last result packet

Definition at line 99 of file LiveAlgorithmResults.cs.


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