Optimization Management

List Optimization

Introduction

List all the optimizations for a project.

Request

Project ID we'd like to get a list of optimizations for. The /optimizations/list API accepts requests in the following format:

ListOptimizationRequest Model - Project ID we'd like to get a list of optimizations for.
projectId integer
Project ID we'd like to get a list of optimizations for.
Example 
{
  "projectId": 0
}

Responses

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

200 Success

ListOptimizationResponse Model - Response received when listing optimizations of a project.
optimizations CreateOptimizationResponse Array
Collection of summarized optimization objects.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example 
{
  "optimizations": [
    {
      "optimizationId": "string",
      "projectId": "string",
      "name": "string",
      "status": "New",
      "nodeType": "O2-8",
      "criterion": {
        "target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
        "extremum": "max or min",
        "target-value": 1
      }
    }
  ],
  "success": true,
  "errors": [
    "string"
  ]
}
CreateOptimizationResponse Model - Response received when launching an optimization job.
optimizationId string
Optimization ID.
projectId string
Project ID of the project the optimization belongs to.
name string
Name of the optimization.
status string Enum
Status of the optimization. Options : ['New', 'Aborted', 'Running', 'Completed']
nodeType string Enum
example: O2-8
Optimization node type. Options : ['O2-8', 'O4-12', 'O8-16']
criterion OptimizationTarget object
/.
Example 
{
  "optimizationId": "string",
  "projectId": "string",
  "name": "string",
  "status": "New",
  "nodeType": "O2-8",
  "criterion": {
    "target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
    "extremum": "max or min",
    "target-value": 1
  }
}
OptimizationTarget Model
target string
example: TotalPerformance.PortfolioStatistics.SharpeRatio
Property we want to track.
extremum string
example: max or min
Defines the direction of optimization.
target-value float
example: 1
The value of the property we want to track.
Example 
{
  "target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
  "extremum": "max or min",
  "target-value": 1
}

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: