read_live_algorithm
Retrieve live algorithm details by providing a project ID. Access real-time status, metrics, and configuration of your QuantConnect strategy's active deployment.
Instructions
Read details of a live algorithm.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| model | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | Error message. | |
| deployId | No | Unique live algorithm deployment identifier (similar to a backtest id). | |
| status | No | State of the live deployment. | |
| cloneId | No | The snapshot project Id for cloning the live development's source code. | |
| launched | No | Datetime the algorithm was launched in UTC. | |
| stopped | No | Datetime the algorithm was stopped in UTC, null if its still running. | |
| brokerage | No | Brokerage | |
| securityTypes | No | Security types detected in the algorithm. | |
| datacenter | No | Name of the datacenter where the algorithm is physically located. | |
| isPublicStreaming | No | Flag to indicate if public streaming is enabled. | |
| public | No | Flag to indicate if the algorithm is public. | |
| files | No | Files present in the project that contains the algorithm. | |
| runtimeStatistics | No | Runtime banner/updating statistics in the title banner of the live algorithm GUI. It can be empty if the algorithm is not running. | |
| charts | No | Chart updates for the live algorithm since the last result packet. | |
| projectName | No | Name of the project the live algorithm is in. | |
| success | No | Indicate if the API request was successful. | |
| errors | No | List of errors with the API call. |