Lean  $LEAN_TAG$
QuantConnect.Api.LiveAlgorithm Class Reference

Live algorithm instance result from the QuantConnect Rest API. More...

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

Properties

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...
 
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.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...
 

Detailed Description

Live algorithm instance result from the QuantConnect Rest API.

Definition at line 24 of file LiveAlgorithm.cs.

Property Documentation

◆ ProjectId

int QuantConnect.Api.LiveAlgorithm.ProjectId
getset

Project id for the live instance

Definition at line 30 of file LiveAlgorithm.cs.

◆ DeployId

string QuantConnect.Api.LiveAlgorithm.DeployId
getset

Unique live algorithm deployment identifier (similar to a backtest id).

Definition at line 36 of file LiveAlgorithm.cs.

◆ Status

AlgorithmStatus QuantConnect.Api.LiveAlgorithm.Status
getset

Algorithm status: running, stopped or runtime error.

Definition at line 42 of file LiveAlgorithm.cs.

◆ Launched

DateTime QuantConnect.Api.LiveAlgorithm.Launched
getset

Datetime the algorithm was launched in UTC.

Definition at line 48 of file LiveAlgorithm.cs.

◆ Stopped

DateTime? QuantConnect.Api.LiveAlgorithm.Stopped
getset

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

Definition at line 54 of file LiveAlgorithm.cs.

◆ Brokerage

string QuantConnect.Api.LiveAlgorithm.Brokerage
getset

Brokerage

Definition at line 60 of file LiveAlgorithm.cs.

◆ Subscription

string QuantConnect.Api.LiveAlgorithm.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 69 of file LiveAlgorithm.cs.

◆ Error

string QuantConnect.Api.LiveAlgorithm.Error
getset

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

Definition at line 75 of file LiveAlgorithm.cs.


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