Read Live Algorithm

Insights

Introduction

Read out the insights of a live algorithm.

Request

Fetch the insights of a live algorithm for the project Id and steps provided. The /live/insights/read API accepts requests in the following format:

ReadLiveInsightsRequest Model - Request to read insights from a live algorithm.
start integer
Starting index of the insights to be fetched. Required if end > 100.
end integer
Last index of the insights to be fetched. Note that end - start must be less than 100.
projectId integer
Id of the project from which to read the live algorithm.
Example 
{
  "start": 0,
  "end": 0,
  "projectId": 0
}

Responses

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

200 Success

LiveInsightsResponse Model - Contains insights and the number of insights of the live algorithm in the request criteria.
insights Insight Array
Collection of insights.
length integer
Total number of returned insights.
success boolean
Indicate if the API request was successful.
Example 
{
  "insights": [
    {
      "id": "string",
      "groupId": "string",
      "sourceModel": "string",
      "generatedTime": "string",
      "createdTime": 0,
      "closeTime": 0,
      "symbol": "string",
      "ticker": "string",
      "type": "price",
      "reference": "string",
      "referenceValueFinal": "string",
      "direction": "down",
      "period": 0,
      "magnitude": 0,
      "confidence": 0,
      "weight": 0,
      "scoreIsFinal": ,
      "scoreDirection": 0,
      "scoreMagnitude": 0,
      "estimatedValue": 0,
      "tag": "2021-11-26T15:18:27.693Z"
    }
  ],
  "length": 0,
  "success": true
}
Insight Model - Insight struct for emitting new prediction.
id string
Insight ID.
groupId string
ID of the group of insights.
sourceModel string
Name of the model that sourced the insight.
generatedTime string
Gets the utc unixtime this insight was generated.
createdTime number
Gets the utc unixtime this insight was created.
closeTime number
Gets the utc unixtime this insight was closed.
symbol string
Gets the symbol ID this insight is for.
ticker string
Gets the symbol ticker this insight is for.
type string Enum
Gets the type of insight, for example, price or volatility. Options : ['price', 'volatility']
reference string
Gets the initial reference value this insight is predicting against.
referenceValueFinal string
Gets the final reference value, used for scoring, this insight is predicting against.
direction string Enum
Gets the predicted direction, down, flat or up. Options : ['down', 'flat', 'up']
period number
Gets the period, in seconds, over which this insight is expected to come to fruition.
magnitude number
Gets the predicted percent change in the insight type (price/volatility). This value can be null.
confidence number
Gets the confidence in this insight. This value can be null.
weight number
Gets the portfolio weight of this insight. This value can be null.
scoreIsFinal bool
Gets whether or not this is the insight's final score.
scoreDirection number
Gets the direction score.
scoreMagnitude number
Gets the magnitude score.
estimatedValue number
Gets the estimated value of this insight in the account currency.
tag string($float)
The insight's tag containing additional information.
Example 
{
  "id": "string",
  "groupId": "string",
  "sourceModel": "string",
  "generatedTime": "string",
  "createdTime": 0,
  "closeTime": 0,
  "symbol": "string",
  "ticker": "string",
  "type": "price",
  "reference": "string",
  "referenceValueFinal": "string",
  "direction": "down",
  "period": 0,
  "magnitude": 0,
  "confidence": 0,
  "weight": 0,
  "scoreIsFinal": ,
  "scoreDirection": 0,
  "scoreMagnitude": 0,
  "estimatedValue": 0,
  "tag": "2021-11-26T15:18:27.693Z"
}

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: