Skip to content

Remove top-level extremum from optimizations/list response #2698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexCatarino merged 1 commit into from
Sep 22, 2026
Merged

Remove top-level extremum from optimizations/list response #2698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 17 additions & 22 deletions ...form/99 API Reference/08 Optimization Management/01 Create Optimization/03 Responses.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ <h4>200 Success</h4>
"name": "string",
"status": ,
"nodeType": "O2-8",
"extremum": "min",
"criterion": {
"target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
"extremum": "min",
Expand Down Expand Up @@ -85,9 +84,6 @@ <h4>200 Success</h4>
<td width="20%">nodeType</td> <td> <code>string Enum</code> <br/> Optimization node types available in QuantConnect Cloud. Options : ['O2-8', 'O4-12', 'O8-16']</td>
</tr>
<tr>
<td width="20%">extremum</td> <td> <code>string Enum</code> <br/> Defines the direction of optimization. Options : ['min', 'max']</td>
</tr>
<tr>
<td width="20%">criterion</td> <td> <code>OptimizationTarget object</code> <br/> Optimization statistical target.</td>
</tr>
<tr>
Expand Down Expand Up @@ -124,7 +120,6 @@ <h4>200 Success</h4>
"name": "string",
"status": ,
"nodeType": "O2-8",
"extremum": "min",
"criterion": {
"target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
"extremum": "min",
Expand Down Expand Up @@ -172,64 +167,64 @@ <h4>200 Success</h4>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>OptimizationTargetTo</code> Model</th>
<th colspan="2"><code>OptimizationTarget</code> Model</th>
</tr>
</thead>
<tr>
<td width="20%">OptimizationParameter</td> <td> <code>string Enum</code> <br/> /. Options : ['min', 'max']</td>
<td width="20%">target</td> <td> <code>string Enum</code> <br/> The target statistic to track. Options : ['TotalPerformance.PortfolioStatistics.SharpeRatio', 'TotalPerformance.PortfolioStatistics.CompoundingAnnualReturn', 'TotalPerformance.PortfolioStatistics.ProbabilisticSharpeRatio', 'TotalPerformance.PortfolioStatistics.Drawdown']</td>
</tr>
<tr>
<td width="20%">extremum</td> <td> <code>string Enum</code> <br/> Defines the direction of optimization. Options : ['min', 'max']</td>
</tr>
<tr>
<td width="20%">targetValue</td> <td> <code>number<br/><i><sub>example: 1</sub></i></code> <br/> Desired value for the optimization target statistic.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"OptimizationParameter": "min"
"target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
"extremum": "min",
"targetValue": 1
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>OptimizationTarget</code> Model</th>
<th colspan="2"><code>OptimizationTargetStatistic</code> Model</th>
</tr>
</thead>
<tr>
<td width="20%">target</td> <td> <code>string Enum</code> <br/> The target statistic to track. Options : ['TotalPerformance.PortfolioStatistics.SharpeRatio', 'TotalPerformance.PortfolioStatistics.CompoundingAnnualReturn', 'TotalPerformance.PortfolioStatistics.ProbabilisticSharpeRatio', 'TotalPerformance.PortfolioStatistics.Drawdown']</td>
</tr>
<tr>
<td width="20%">extremum</td> <td> <code>string Enum</code> <br/> Defines the direction of optimization. Options : ['min', 'max']</td>
</tr>
<tr>
<td width="20%">targetValue</td> <td> <code>number<br/><i><sub>example: 1</sub></i></code> <br/> Desired value for the optimization target statistic.</td>
<td width="20%">OptimizationParameter</td> <td> <code>string Enum</code> <br/> /. Options : ['TotalPerformance.PortfolioStatistics.SharpeRatio', 'TotalPerformance.PortfolioStatistics.CompoundingAnnualReturn', 'TotalPerformance.PortfolioStatistics.ProbabilisticSharpeRatio', 'TotalPerformance.PortfolioStatistics.Drawdown']</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
"extremum": "min",
"targetValue": 1
"OptimizationParameter": "TotalPerformance.PortfolioStatistics.SharpeRatio"
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>OptimizationTargetStatistic</code> Model</th>
<th colspan="2"><code>OptimizationTargetTo</code> Model</th>
</tr>
</thead>
<tr>
<td width="20%">OptimizationParameter</td> <td> <code>string Enum</code> <br/> /. Options : ['TotalPerformance.PortfolioStatistics.SharpeRatio', 'TotalPerformance.PortfolioStatistics.CompoundingAnnualReturn', 'TotalPerformance.PortfolioStatistics.ProbabilisticSharpeRatio', 'TotalPerformance.PortfolioStatistics.Drawdown']</td>
<td width="20%">OptimizationParameter</td> <td> <code>string Enum</code> <br/> /. Options : ['min', 'max']</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"OptimizationParameter": "TotalPerformance.PortfolioStatistics.SharpeRatio"
"OptimizationParameter": "min"
}</pre>
</div>
</td>
Expand Down
39 changes: 17 additions & 22 deletions ...atform/99 API Reference/08 Optimization Management/06 List Optimization/03 Responses.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ <h4>200 Success</h4>
"name": "string",
"status": ,
"nodeType": "O2-8",
"extremum": "min",
"criterion": {
"target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
"extremum": "min",
Expand Down Expand Up @@ -85,9 +84,6 @@ <h4>200 Success</h4>
<td width="20%">nodeType</td> <td> <code>string Enum</code> <br/> Optimization node types available in QuantConnect Cloud. Options : ['O2-8', 'O4-12', 'O8-16']</td>
</tr>
<tr>
<td width="20%">extremum</td> <td> <code>string Enum</code> <br/> Defines the direction of optimization. Options : ['min', 'max']</td>
</tr>
<tr>
<td width="20%">criterion</td> <td> <code>OptimizationTarget object</code> <br/> Optimization statistical target.</td>
</tr>
<tr>
Expand Down Expand Up @@ -124,7 +120,6 @@ <h4>200 Success</h4>
"name": "string",
"status": ,
"nodeType": "O2-8",
"extremum": "min",
"criterion": {
"target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
"extremum": "min",
Expand Down Expand Up @@ -172,64 +167,64 @@ <h4>200 Success</h4>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>OptimizationTargetTo</code> Model</th>
<th colspan="2"><code>OptimizationTarget</code> Model</th>
</tr>
</thead>
<tr>
<td width="20%">OptimizationParameter</td> <td> <code>string Enum</code> <br/> /. Options : ['min', 'max']</td>
<td width="20%">target</td> <td> <code>string Enum</code> <br/> The target statistic to track. Options : ['TotalPerformance.PortfolioStatistics.SharpeRatio', 'TotalPerformance.PortfolioStatistics.CompoundingAnnualReturn', 'TotalPerformance.PortfolioStatistics.ProbabilisticSharpeRatio', 'TotalPerformance.PortfolioStatistics.Drawdown']</td>
</tr>
<tr>
<td width="20%">extremum</td> <td> <code>string Enum</code> <br/> Defines the direction of optimization. Options : ['min', 'max']</td>
</tr>
<tr>
<td width="20%">targetValue</td> <td> <code>number<br/><i><sub>example: 1</sub></i></code> <br/> Desired value for the optimization target statistic.</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"OptimizationParameter": "min"
"target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
"extremum": "min",
"targetValue": 1
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>OptimizationTarget</code> Model</th>
<th colspan="2"><code>OptimizationTargetStatistic</code> Model</th>
</tr>
</thead>
<tr>
<td width="20%">target</td> <td> <code>string Enum</code> <br/> The target statistic to track. Options : ['TotalPerformance.PortfolioStatistics.SharpeRatio', 'TotalPerformance.PortfolioStatistics.CompoundingAnnualReturn', 'TotalPerformance.PortfolioStatistics.ProbabilisticSharpeRatio', 'TotalPerformance.PortfolioStatistics.Drawdown']</td>
</tr>
<tr>
<td width="20%">extremum</td> <td> <code>string Enum</code> <br/> Defines the direction of optimization. Options : ['min', 'max']</td>
</tr>
<tr>
<td width="20%">targetValue</td> <td> <code>number<br/><i><sub>example: 1</sub></i></code> <br/> Desired value for the optimization target statistic.</td>
<td width="20%">OptimizationParameter</td> <td> <code>string Enum</code> <br/> /. Options : ['TotalPerformance.PortfolioStatistics.SharpeRatio', 'TotalPerformance.PortfolioStatistics.CompoundingAnnualReturn', 'TotalPerformance.PortfolioStatistics.ProbabilisticSharpeRatio', 'TotalPerformance.PortfolioStatistics.Drawdown']</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"target": "TotalPerformance.PortfolioStatistics.SharpeRatio",
"extremum": "min",
"targetValue": 1
"OptimizationParameter": "TotalPerformance.PortfolioStatistics.SharpeRatio"
}</pre>
</div>
</td>
</tr>
</table><table class="table qc-table">
<thead>
<tr>
<th colspan="2"><code>OptimizationTargetStatistic</code> Model</th>
<th colspan="2"><code>OptimizationTargetTo</code> Model</th>
</tr>
</thead>
<tr>
<td width="20%">OptimizationParameter</td> <td> <code>string Enum</code> <br/> /. Options : ['TotalPerformance.PortfolioStatistics.SharpeRatio', 'TotalPerformance.PortfolioStatistics.CompoundingAnnualReturn', 'TotalPerformance.PortfolioStatistics.ProbabilisticSharpeRatio', 'TotalPerformance.PortfolioStatistics.Drawdown']</td>
<td width="20%">OptimizationParameter</td> <td> <code>string Enum</code> <br/> /. Options : ['min', 'max']</td>
</tr>
<tr>
<td width="20%">Example</td>
<td>
<div class="cli section-example-container"><pre>
{
"OptimizationParameter": "TotalPerformance.PortfolioStatistics.SharpeRatio"
"OptimizationParameter": "min"
}</pre>
</div>
</td>
Expand Down
3 changes: 0 additions & 3 deletions QuantConnect-Platform-2.0.0.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4430,9 +4430,6 @@ components:
nodeType:
description: Optimization node type.
$ref: '#/components/schemas/OptimizationNodeType'
extremum:
description: Defines the direction of optimization.
$ref: '#/components/schemas/OptimizationTargetTo'
criterion:
type: object
description: Optimization statistical target.
Expand Down
Loading