Lean  $LEAN_TAG$
QuantConnect.Api.LiveAlgorithmSummary Class Reference

Response from List Live Algorithms request to QuantConnect Rest API. More...

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

Properties

AlgorithmStatus Status [get, set]
 Algorithm status: running, stopped or runtime error. More...
 
DateTime Launched [get, set]
 Datetime the algorithm was launched in UTC. More...
 
DateTime? Stopped [get, set]
 Datetime the algorithm was stopped in UTC, null if its still running. More...
 
string Brokerage [get, set]
 Brokerage More...
 
string Subscription [get, set]
 Chart we're subscribed to More...
 
string Error [get, set]
 Live algorithm error message from a crash or algorithm runtime error. More...
 
- Properties inherited from QuantConnect.Api.BaseLiveAlgorithm
int ProjectId [get, set]
 Project id for the live instance More...
 
string DeployId [get, set]
 Unique live algorithm deployment identifier (similar to a backtest id). 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

Response from List Live Algorithms request to QuantConnect Rest API.

Definition at line 61 of file LiveAlgorithm.cs.

Property Documentation

◆ Status

AlgorithmStatus QuantConnect.Api.LiveAlgorithmSummary.Status
getset

Algorithm status: running, stopped or runtime error.

Definition at line 66 of file LiveAlgorithm.cs.

◆ Launched

DateTime QuantConnect.Api.LiveAlgorithmSummary.Launched
getset

Datetime the algorithm was launched in UTC.

Definition at line 71 of file LiveAlgorithm.cs.

◆ Stopped

DateTime? QuantConnect.Api.LiveAlgorithmSummary.Stopped
getset

Datetime the algorithm was stopped in UTC, null if its still running.

Definition at line 76 of file LiveAlgorithm.cs.

◆ Brokerage

string QuantConnect.Api.LiveAlgorithmSummary.Brokerage
getset

Brokerage

Definition at line 81 of file LiveAlgorithm.cs.

◆ Subscription

string QuantConnect.Api.LiveAlgorithmSummary.Subscription
getset

Chart we're subscribed to

Data limitations mean we can only stream one chart at a time to the consumer. See which chart you're watching here.

Definition at line 89 of file LiveAlgorithm.cs.

◆ Error

string QuantConnect.Api.LiveAlgorithmSummary.Error
getset

Live algorithm error message from a crash or algorithm runtime error.

Definition at line 94 of file LiveAlgorithm.cs.


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