Read Live Algorithm
Insights
Request
Fetch the insights of a live algorithm for the project Id and steps provided. The /live/read/insights
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/read/insights
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", "Time": 0, "SignalDirection": "Down", "Type": "Price", "Symbol": "string", "Direction": 0, "Magnitude": 0, "Period": 0, "Weight": 0 } ], "length": 0, "success": true } |
Insight Model - Insight struct for emitting new prediction. | |
---|---|
Id | string Insight ID. |
Time | number Gets the utc unixtime this insight was created. |
SignalDirection | string Enum Gets the predicted direction, down, flat or up. Options : ['Down', 'Flat', 'Up'] |
Type | string Enum Gets the type of insight, for example, price or volatility. Options : ['Price', 'Volatility'] |
Symbol | string Gets the symbol this insight is for. |
Direction | number Gets the direction score. |
Magnitude | number Gets the magnitude score. |
Period | number Gets the period, in seconds, over which this insight is expected to come to fruition. |
Weight | number Gets the portfolio weight of this insight. |
Example |
{ "Id": "string", "Time": 0, "SignalDirection": "Down", "Type": "Price", "Symbol": "string", "Direction": 0, "Magnitude": 0, "Period": 0, "Weight": 0 } |
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 |