Read Live Algorithm

Charts

Introduction

Read a chart from a live algorithm.

Request

Request body to obtain a chart from a live algorithm. The /live/chart/read API accepts requests in the following format:

ReadLiveChartRequest Model - Request to body to obtain a chart from a live algorithm.
projectId integer
Project ID of the request.
name string
The requested chart name.
start integer
The Utc start seconds timestamp of the request.
end integer
The Utc end seconds timestamp of the request.
count integer
The number of data points to request.
Example 
{
  "projectId": 0,
  "name": "string",
  "start": 0,
  "end": 0,
  "count": 0
}

Responses

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

200 Success

LoadingChartResponse Model - Response when the requested chart is being generated.
progress number
Loading percentage of the chart generation process.
status string
example: loading
Status of the chart generation process.
success boolean
Indicate if the API request was successful.
Example 
{
  "progress": 0,
  "status": "loading",
  "success": true
}
ReadChartResponse Model - Response with the requested chart from a live algorithm or backtest.
chart Chart object
Single Parent Chart Object for Custom Charting.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example 
{
  "chart": {
    "name": "string",
    "chartType": "Overlay",
    "series": {
      "name": "string",
      "unit": "string",
      "index": 0,
      "values": [
        "object"
      ],
      "seriesType": "Line",
      "color": "string",
      "scatterMarkerSymbol": "none"
    }
  },
  "success": true,
  "errors": [
    "string"
  ]
}
Chart Model - Single Parent Chart Object for Custom Charting.
name string
Name of the Chart.
chartType string Enum
Type of the Chart, Overlayed or Stacked. Options : ['Overlay', 'Stacked']
series Series object
List of Series Objects for this Chart.
Example 
{
  "name": "string",
  "chartType": "Overlay",
  "series": {
    "name": "string",
    "unit": "string",
    "index": 0,
    "values": [
      "object"
    ],
    "seriesType": "Line",
    "color": "string",
    "scatterMarkerSymbol": "none"
  }
}
Series Model - Chart Series Object - Series data and properties for a chart.
name string
Name of the series.
unit string
Axis for the chart series.
index integer
Index/position of the series on the chart.
values object Array
Values for the series plot. These values are assumed to be in ascending time order (first points earliest, last points latest).
seriesType string Enum
Chart type for the series. Options : ['Line', 'Scatter', 'Candle', 'Bar', 'Flag', 'StackedArea', 'Pie', 'Treemap']
color string
Color the series.
scatterMarkerSymbol string Enum
Shape or symbol for the marker in a scatter plot. Options : ['none', 'circle', 'square', 'diamond', 'triangle', 'triangle-down']
Example 
{
  "name": "string",
  "unit": "string",
  "index": 0,
  "values": [
    "object"
  ],
  "seriesType": "Line",
  "color": "string",
  "scatterMarkerSymbol": "none"
}

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: