Live Management

List Live Algorithms

Introduction

Returns a list of live running algorithms.

Request

Request body to obtain a list of live running algorithms. The /live/list API accepts requests in the following format:

ListLiveAlgorithmsRequest Model - Request for a list of live running algorithms.
status string Enum
States of a live deployment. Options : ['DeployError', 'InQueue', 'Running', 'Stopped', 'Liquidated', 'Deleted', 'Completed', 'RuntimeError', 'Invalid', 'LoggingIn', 'Initializing', 'History']
start number
Earliest launched time of the algorithms in UNIX timestamp.
end number
Latest launched time of the algorithms in UNIX timestamp.
Example 
{
  "status": "DeployError",
  "start": 0,
  "end": 0
}

Responses

The /live/list API provides a response in the following format:

200 Success

LiveAlgorithmListResponse Model - List of the live algorithms running which match the requested status.
live LiveAlgorithm Array
Algorithm list matching the requested status.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example 
{
  "live": [
    {
      "projectId": 0,
      "deployId": "string",
      "status": "DeployError",
      "launched": "2021-11-26T15:18:27.693Z",
      "stopped": "2021-11-26T15:18:27.693Z",
      "brokerage": "Interactive",
      "subscription": "string",
      "error": "string",
      "success": true,
      "errors": [
        "string"
      ]
    }
  ],
  "success": true,
  "errors": [
    "string"
  ]
}
LiveAlgorithm Model - Live algorithm instance result from the QuantConnect Rest API.
projectId integer
Project Id for the live instance.
deployId string
Unique live algorithm deployment identifier (similar to a backtest id).
status string Enum
States of a live deployment. Options : ['DeployError', 'InQueue', 'Running', 'Stopped', 'Liquidated', 'Deleted', 'Completed', 'RuntimeError', 'Invalid', 'LoggingIn', 'Initializing', 'History']
launched string($date-time)
Datetime the algorithm was launched in UTC.
stopped string($date-time)
Datetime the algorithm was stopped in UTC, null if its still running.
brokerage string Enum
Brokerage. Options : ['Interactive', 'FXCM', 'Oanda', 'Tradier', 'PaperBrokerage', 'Alpaca', 'Bitfinex', 'Binance', 'Coinbase']
subscription string
Chart we're subscribed to.
error string
Live algorithm error message from a crash or algorithm runtime error.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example 
{
  "projectId": 0,
  "deployId": "string",
  "status": "DeployError",
  "launched": "2021-11-26T15:18:27.693Z",
  "stopped": "2021-11-26T15:18:27.693Z",
  "brokerage": "Interactive",
  "subscription": "string",
  "error": "string",
  "success": true,
  "errors": [
    "string"
  ]
}

401 Authentication Error

UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: