Skip to content

Commit 932000f

Browse files
GitHubAlexCatarino
GitHub
authored and
AlexCatarino
committed
Code generated by SinglePageDocGenerator.py
1 parent fed97f9 commit 932000f

3 files changed

+22114
-3703
lines changed

‎single-page/Quantconnect-Cloud-Platform.html

+323-1
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,8 @@ <h3>Table of Content</h3>
194194
<li><a href="#14.6.3.2" class="toc-h4" target="_parent">14.6.3.2 Stop Live Algorithm</a></li>
195195
<li><a href="#14.6.4" class="toc-h3" target="_parent">14.6.4 List Live Algorithms</a></li>
196196
<li><a href="#14.6.5" class="toc-h3" target="_parent">14.6.5 Live Commands</a></li>
197+
<li><a href="#14.6.5.1" class="toc-h4" target="_parent">14.6.5.1 Create Live Command</a></li>
198+
<li><a href="#14.6.5.2" class="toc-h4" target="_parent">14.6.5.2 Broadcast Live Command</a></li>
197199
<li><a href="#14.7" class="toc-h2" target="_parent">14.7 Optimization Management</a></li>
198200
<li><a href="#14.7.1" class="toc-h3" target="_parent">14.7.1 Create Optimization</a></li>
199201
<li><a href="#14.7.2" class="toc-h3" target="_parent">14.7.2 Update Optimization</a></li>
@@ -893,6 +895,19 @@ <h3>Rename Organizations</h3>
893895
</body>
894896
</html>
895897

898+
<h3>Get Organization Id</h3>
899+
<html>
900+
<body>
901+
<p>
902+
To get the organization Id, open
903+
<a class="menu-name" href="#4.7">
904+
Organization &gt; Home
905+
</a>
906+
and check the URL. For example, the organization Id of https://www.quantconnect.com/organization/5cad178b20a1d52567b534553413b691 is 5cad178b20a1d52567b534553413b691.
907+
</p>
908+
</body>
909+
</html>
910+
896911
<h3>Out of Sample Period</h3>
897912
<html>
898913
<body>
@@ -5106,6 +5121,19 @@ <h3>Set a Preferred Organization</h3>
51065121
</body>
51075122
</html>
51085123

5124+
<h3>Get Organization Id</h3>
5125+
<html>
5126+
<body>
5127+
<p>
5128+
To get the organization Id, open
5129+
<a class="menu-name" href="#4.7">
5130+
Organization &gt; Home
5131+
</a>
5132+
and check the URL. For example, the organization Id of https://www.quantconnect.com/organization/5cad178b20a1d52567b534553413b691 is 5cad178b20a1d52567b534553413b691.
5133+
</p>
5134+
</body>
5135+
</html>
5136+
51095137
<h3>Out of Sample Period</h3>
51105138
<html>
51115139
<body>
@@ -27868,6 +27896,20 @@ <h4>
2786827896
<td>
2786927897
</td>
2787027898
</tr>
27899+
<tr>
27900+
<td>
27901+
<a href="https://www.quantconnect.com/docs/v2//writing-algorithms/trading-and-orders/order-types/market-on-close-orders">
27902+
Market on close
27903+
</a>
27904+
</td>
27905+
<td>
27906+
<img alt="green check" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACYAAAAbCAYAAAAQ2f3dAAAAAXNSR0IArs4c6QAAAVVJREFUWAnN1891gjAcB/DfDxygI/Sij6Mb2BHq6wLpBt1EN9AFfIxivXlkBDy1p8Z8BYQoaAJJ6O9g/hCTDyGPBKL/Eul0TmnyWnGiKjNquks2JCd7kryndPYOy/gwoJhFOTEvJKPV+DAdVdr4gMykLIVPWlHyQPwrgOHwIjViN+qNllk+DswAFR5miAoLs0CFg1miwsB6oPzDeqIAq9/8N3sVLg6KASiMW8DQSbVX7RIxCIQ/D0ShCybMFFDNkPKTPo7bZpVx3gEKY6kZi3OS8qQNzLxRdy20OpOCIxSGimh5zFT6hYIWtjiHKDjqvRIzBMxtmDxWxygdhlIfnAfUPcwW5wnVDjPFeUR1w57hiBaN4zBaq7gc8q7nqaKu/2+9+Nv66Fpzd23dotD9YxhaPMW5R5nBHuL8oMxhrTh/KDsYWuNj9C9eqwXwTfwjqg8HXHIdZ1FC4cPAvVO4AAAAAElFTkSuQmCC" width="15px;"/>
27907+
</td>
27908+
<td>
27909+
</td>
27910+
<td>
27911+
</td>
27912+
</tr>
2787127913
<tr>
2787227914
<td>
2787327915
<a href="https://www.quantconnect.com/docs/v2//writing-algorithms/trading-and-orders/order-types/combo-market-orders">
@@ -30402,6 +30444,22 @@ <h3>Troubleshooting</h3>
3040230444
and provide the algorithm Id and deployment Id.
3040330445
</td>
3040430446
</tr>
30447+
<tr>
30448+
<td nowrap="">
30449+
<div class="error-messages">
30450+
Login to the IB Gateway failed because
30451+
<br/>
30452+
a user account-tasks is required.
30453+
</div>
30454+
</td>
30455+
<td>
30456+
Download
30457+
<a href="https://www.interactivebrokers.com/en/trading/ibgateway-stable.php" rel="nofollow" target="_blank">
30458+
IB Gateway
30459+
</a>
30460+
, run it, and follow the instructions provided.
30461+
</td>
30462+
</tr>
3040530463
<tr>
3040630464
<td rowspan="2">
3040730465
<div class="error-messages">
@@ -30511,7 +30569,7 @@ <h3>Troubleshooting</h3>
3051130569
</div>
3051230570
</td>
3051330571
<td>
30514-
IB didn't repond to an order request. Stop and re-deploy the algorithm. On the next deployment, LEAN retrieves this order or the positions it opened or closed.
30572+
IB didn't respond to an order request. Stop and re-deploy the algorithm. On the next deployment, LEAN retrieves this order or the positions it opened or closed.
3051530573
</td>
3051630574
</tr>
3051730575
</tbody>
@@ -68692,6 +68750,50 @@ <h1>Live Management</h1>
6869268750
<h2>Live Commands</h2>
6869368751
</section>
6869468752
</div>
68753+
<html>
68754+
<body>
68755+
<div class="sub-heading-landing">
68756+
<div class="internal-content">
68757+
<p>
68758+
The QuantConnect REST API send commands to live algorithms on our cloud servers through URL endpoints.
68759+
</p>
68760+
</div>
68761+
<div class="docs-landing-links">
68762+
<div class="col-md-6 col-sm-12 docs-landing-link-wrap">
68763+
<a class="docs-landing-link" href="/docs/v2/cloud-platform/api-reference/live-management/live-commands/create-live-command">
68764+
<div class="content clickable" onclick="window.location.href = '#14.6.5.1'">
68765+
<div class="docs-internal-link">
68766+
<h4>
68767+
Create Live Command
68768+
</h4>
68769+
</div>
68770+
</div>
68771+
</a>
68772+
</div>
68773+
<div class="col-md-6 col-sm-12 docs-landing-link-wrap">
68774+
<a class="docs-landing-link" href="/docs/v2/cloud-platform/api-reference/live-management/live-commands/broadcast-live-command">
68775+
<div class="content clickable" onclick="window.location.href = '#14.6.5.2'">
68776+
<div class="docs-internal-link">
68777+
<h4>
68778+
Broadcast Live Command
68779+
</h4>
68780+
</div>
68781+
</div>
68782+
</a>
68783+
</div>
68784+
</div>
68785+
</div>
68786+
</body>
68787+
</html>
68788+
68789+
<p style="page-break-after: always;">&nbsp;</p>
68790+
<p class='page-breadcrumb'>API Reference > Live Management > Live Commands > Create Live Command</p>
68791+
<div class='page-heading'>
68792+
<section id="14.6.5.1">
68793+
<h1>Live Commands</h1>
68794+
<h2>Create Live Command</h2>
68795+
</section>
68796+
</div>
6869568797
<h3>Introduction</h3>
6869668798
<!-- Code generated by API-Reference-Code-Generator.py -->
6869768799
<html>
@@ -68885,6 +68987,226 @@ <h4>
6888568987
</body>
6888668988
</html>
6888768989

68990+
<p style="page-break-after: always;">&nbsp;</p>
68991+
<p class='page-breadcrumb'>API Reference > Live Management > Live Commands > Broadcast Live Command</p>
68992+
<div class='page-heading'>
68993+
<section id="14.6.5.2">
68994+
<h1>Live Commands</h1>
68995+
<h2>Broadcast Live Command</h2>
68996+
</section>
68997+
</div>
68998+
<h3>Introduction</h3>
68999+
<!-- Code generated by API-Reference-Code-Generator.py -->
69000+
<html>
69001+
<body>
69002+
<p>
69003+
Broadcast a live command to all live algorithms in the organization.
69004+
</p>
69005+
</body>
69006+
</html>
69007+
69008+
<h3>Request</h3>
69009+
<!-- Code generated by API-Reference-Code-Generator.py -->
69010+
<html>
69011+
<body>
69012+
<p>
69013+
Broadcasts a command to all live deployments in the organization. The
69014+
<code>
69015+
/live/commands/broadcast
69016+
</code>
69017+
API accepts requests in the following format:
69018+
</p>
69019+
<table class="table qc-table">
69020+
<thead>
69021+
<tr>
69022+
<th colspan="2">
69023+
<code>
69024+
BroadcastLiveCommandRequest
69025+
</code>
69026+
Model - Request to create a live command.
69027+
</th>
69028+
</tr>
69029+
</thead>
69030+
<tr>
69031+
<td width="20%">
69032+
organizationId
69033+
</td>
69034+
<td>
69035+
<code>
69036+
string
69037+
<br/>
69038+
<i>
69039+
<sub>
69040+
example: 5cad178b20a1d52567b534553413b691
69041+
</sub>
69042+
</i>
69043+
</code>
69044+
<br/>
69045+
Organization Id of the projects we would like to broadcast the command to.
69046+
</td>
69047+
</tr>
69048+
<tr>
69049+
<td width="20%">
69050+
excludeProjectId
69051+
</td>
69052+
<td>
69053+
<code>
69054+
integer
69055+
<br/>
69056+
<i>
69057+
<sub>
69058+
example: 19626262
69059+
</sub>
69060+
</i>
69061+
</code>
69062+
<br/>
69063+
Project for the live instance we want to exclude from the broadcast list. If null, all projects will be included.
69064+
</td>
69065+
</tr>
69066+
<tr>
69067+
<td width="20%">
69068+
command
69069+
</td>
69070+
<td>
69071+
<code>
69072+
object
69073+
<br/>
69074+
<i>
69075+
<sub>
69076+
example: {'$type': 'OrderCommand', 'symbol': {'id': 'BTCUSD 2XR', 'value': 'BTCUSD'}, 'order_type': 'market', 'quantity': '0.1', 'limit_price': 0, 'stop_price': 0, 'tag': ''}
69077+
</sub>
69078+
</i>
69079+
</code>
69080+
<br/>
69081+
The command to run.
69082+
</td>
69083+
</tr>
69084+
<tr>
69085+
<td width="20%">
69086+
Example
69087+
</td>
69088+
<td>
69089+
<div class="cli section-example-container">
69090+
<pre>
69091+
{
69092+
"organizationId": "5cad178b20a1d52567b534553413b691",
69093+
"excludeProjectId": 19626262,
69094+
"command": {
69095+
"$type": "OrderCommand",
69096+
"symbol": {
69097+
"id": "BTCUSD 2XR",
69098+
"value": "BTCUSD"
69099+
},
69100+
"order_type": "market",
69101+
"quantity": "0.1",
69102+
"limit_price": 0,
69103+
"stop_price": 0,
69104+
"tag": ""
69105+
}
69106+
}</pre>
69107+
</div>
69108+
</td>
69109+
</tr>
69110+
</table>
69111+
</body>
69112+
</html>
69113+
69114+
<h3>Responses</h3>
69115+
<!-- Code generated by API-Reference-Code-Generator.py -->
69116+
<html>
69117+
<body>
69118+
<p>
69119+
The
69120+
<code>
69121+
/live/commands/broadcast
69122+
</code>
69123+
API provides a response in the following format:
69124+
</p>
69125+
<h4>
69126+
200 Success
69127+
</h4>
69128+
<table class="table qc-table">
69129+
<thead>
69130+
<tr>
69131+
<th colspan="2">
69132+
<code>
69133+
RestResponse
69134+
</code>
69135+
Model - Base API response class for the QuantConnect API.
69136+
</th>
69137+
</tr>
69138+
</thead>
69139+
<tr>
69140+
<td width="20%">
69141+
success
69142+
</td>
69143+
<td>
69144+
<code>
69145+
boolean
69146+
</code>
69147+
<br/>
69148+
Indicate if the API request was successful.
69149+
</td>
69150+
</tr>
69151+
<tr>
69152+
<td width="20%">
69153+
errors
69154+
</td>
69155+
<td>
69156+
<code>
69157+
string Array
69158+
</code>
69159+
<br/>
69160+
List of errors with the API call.
69161+
</td>
69162+
</tr>
69163+
<tr>
69164+
<td width="20%">
69165+
Example
69166+
</td>
69167+
<td>
69168+
<div class="cli section-example-container">
69169+
<pre>
69170+
{
69171+
"success": true,
69172+
"errors": [
69173+
"string"
69174+
]
69175+
}</pre>
69176+
</div>
69177+
</td>
69178+
</tr>
69179+
</table>
69180+
<h4>
69181+
401 Authentication Error
69182+
</h4>
69183+
<table class="table qc-table">
69184+
<thead>
69185+
<tr>
69186+
<th colspan="2">
69187+
<code>
69188+
UnauthorizedError
69189+
</code>
69190+
Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
69191+
</th>
69192+
</tr>
69193+
</thead>
69194+
<tr>
69195+
<td width="20%">
69196+
www_authenticate
69197+
</td>
69198+
<td>
69199+
<code>
69200+
string
69201+
</code>
69202+
<br/>
69203+
Header
69204+
</td>
69205+
</tr>
69206+
</table>
69207+
</body>
69208+
</html>
69209+
6888869210
<p style="page-break-after: always;">&nbsp;</p>
6888969211
<p class='page-breadcrumb'>API Reference > Optimization Management</p>
6889069212
<div class='page-heading'>

0 commit comments

Comments
 (0)