Skip to content

Commit

Permalink
Code generated by Writing-Algorithm-API-Ref-Code-Generator.py
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub authored and AlexCatarino committed Mar 13, 2024
1 parent 6ea2ded commit 17aefc6
Show file tree
Hide file tree
Showing 26 changed files with 1,082 additions and 738 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@
</tr>
<tr>
<td width="33%"><a href="#TrailingStopOrder-header">TrailingStopOrder()</a></td>
<td>Create a trailing stop order and return the newly created order id; or negative if the order is invalid.</td>
<td>Create a trailing stop order and return the newly created order id; or negative if the order is invalid. It will calculate the stop price using the trailing amount and the current market price.</td>
</tr>
<tr>
<td width="33%"><a href="#Train-header">Train()</a></td>
Expand Down Expand Up @@ -2006,7 +2006,7 @@
</tr>
<tr>
<td width="33%"><a href="#TrailingStopOrder-header">TrailingStopOrder()</a></td>
<td>Create a trailing stop order and return the newly created order id; or negative if the order is invalid.</td>
<td>Create a trailing stop order and return the newly created order id; or negative if the order is invalid. It will calculate the stop price using the trailing amount and the current market price.</td>
</tr>
</tbody></table>
</div><div id="Universes" class="ref-table-container">
Expand Down
66 changes: 66 additions & 0 deletions Resources/qcalgorithm-api/.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<a id="ρ-header"></a>
<div class="method-container">

<div class="method-header">
<button class="method-tag" onclick="openTopTab(event, 'Indicators')">Indicators</button>
<h3>ρ()<span class="method-order">1/1</span></h3>
<pre>
<font color="#8F9CA3">Rho</font> QuantConnect.Algorithm.QCAlgorithm.ρ (
&emsp;<code>Symbol</code> symbol,
&emsp;<code>*Symbol</code> mirrorOption,
&emsp;<code>*Nullable&lt;Decimal&gt;</code> riskFreeRate,
&emsp;<code>*Nullable&lt;Decimal&gt;</code> dividendYield,
&emsp;<code>*OptionPricingModelType</code> optionModel,
&emsp;<code>*Nullable&lt;OptionPricingModelType&gt;</code> ivModel,
&emsp;<code>*Nullable&lt;Resolution&gt;</code> resolution
)
</pre>
</div>

<div class="method-description">
<p>Creates a new Rho indicator for the symbol The indicator will be automatically updated on the symbol's subscription resolution.</p>
</div>

<div class="details-btn">
<button class="show-hide-detail" onclick="ShowHide(event, 'ρ(Symbol-symbol,-*Symbol-mirrorOption,-*Nullable&lt;Decimal&gt;-riskFreeRate,-*Nullable&lt;Decimal&gt;-dividendYield,-*OptionPricingModelType-optionModel,-*Nullable&lt;OptionPricingModelType&gt;-ivModel,-*Nullable&lt;Resolution&gt;-resolution)-details')"><span>Show Details <img src='https://cdn.quantconnect.com/i/tu/api-chevron-show.svg' alt='arrow-show'></span></button>
</div>

<div class="method-details" id="ρ(Symbol-symbol,-*Symbol-mirrorOption,-*Nullable&lt;Decimal&gt;-riskFreeRate,-*Nullable&lt;Decimal&gt;-dividendYield,-*OptionPricingModelType-optionModel,-*Nullable&lt;OptionPricingModelType&gt;-ivModel,-*Nullable&lt;Resolution&gt;-resolution)-details" style="display: none;" >

<div class="parameter-list">
<table class="parameter-table">
<th><strong>Parameters</strong></th>
<tr><td><code>Symbol</code></td>
<td>symbol</td>
<td>The option symbol whose values we want as an indicator.</td></tr>
<tr><td><code>*Symbol</code></td>
<td>mirrorOption</td>
<td><span class='qualifier'>(Optional)</span> The mirror option for parity calculation.</td></tr>
<tr><td><code>*Nullable&lt;Decimal&gt;</code></td>
<td>riskFreeRate</td>
<td><span class='qualifier'>(Optional)</span> The risk free rate.</td></tr>
<tr><td><code>*Nullable&lt;Decimal&gt;</code></td>
<td>dividendYield</td>
<td><span class='qualifier'>(Optional)</span> The dividend yield.</td></tr>
<tr><td><code>*OptionPricingModelType</code></td>
<td>optionModel</td>
<td><span class='qualifier'>(Optional)</span> The option pricing model used to estimate Rho.</td></tr>
<tr><td><code>*Nullable&lt;OptionPricingModelType&gt;</code></td>
<td>ivModel</td>
<td><span class='qualifier'>(Optional)</span> The option pricing model used to estimate IV.</td></tr>
<tr><td><code>*Nullable&lt;Resolution&gt;</code></td>
<td>resolution</td>
<td><span class='qualifier'>(Optional)</span> The desired resolution of the data.</td></tr>
</table>
</div>

<div class="method-return">
<h4>Return</h4>
<p><code>Rho</code> - A new Rho indicator for the specified symbol.</p>
</div>

<div class="method-def">
<p>Definition at <a rel="nofollow" target="_blank" href="https://github.com/QuantConnect/Lean/blob/master/Algorithm/QCAlgorithm.Indicators.cs#L1692">line 1692 of file Algorithm/QCAlgorithm.Indicators.cs.</a></p>
</div>
</div>
</div>
6 changes: 3 additions & 3 deletions Resources/qcalgorithm-api/add-universe-options.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h4>Return</h4>
</div>

<div class="method-def">
<p>Definition at <a rel="nofollow" target="_blank" href="https://github.com/QuantConnect/Lean/blob/master/Algorithm/QCAlgorithm.Universe.cs#L485">line 485 of file Algorithm/QCAlgorithm.Universe.cs.</a></p>
<p>Definition at <a rel="nofollow" target="_blank" href="https://github.com/QuantConnect/Lean/blob/master/Algorithm/QCAlgorithm.Universe.cs#L512">line 512 of file Algorithm/QCAlgorithm.Universe.cs.</a></p>
</div>
</div>

Expand Down Expand Up @@ -83,7 +83,7 @@ <h4>Return</h4>
</div>

<div class="method-def">
<p>Definition at <a rel="nofollow" target="_blank" href="https://github.com/QuantConnect/Lean/blob/master/Algorithm/QCAlgorithm.Universe.cs#L515">line 515 of file Algorithm/QCAlgorithm.Universe.cs.</a></p>
<p>Definition at <a rel="nofollow" target="_blank" href="https://github.com/QuantConnect/Lean/blob/master/Algorithm/QCAlgorithm.Universe.cs#L542">line 542 of file Algorithm/QCAlgorithm.Universe.cs.</a></p>
</div>
</div>

Expand Down Expand Up @@ -126,7 +126,7 @@ <h4>Return</h4>
</div>

<div class="method-def">
<p>Definition at <a rel="nofollow" target="_blank" href="https://github.com/QuantConnect/Lean/blob/master/Algorithm/QCAlgorithm.Python.cs#L513">line 513 of file Algorithm/QCAlgorithm.Python.cs.</a></p>
<p>Definition at <a rel="nofollow" target="_blank" href="https://github.com/QuantConnect/Lean/blob/master/Algorithm/QCAlgorithm.Python.cs#L529">line 529 of file Algorithm/QCAlgorithm.Python.cs.</a></p>
</div>
</div>
</div>
Loading

0 comments on commit 17aefc6

Please sign in to comment.