Updates Broadcast Live Command

Author: AlexCatarino

01 Cloud Platform/99 API Reference/07 Live Management/05 Live Commands/02 Broadcast Live Command/02 Request.html

@@ -9,7 +9,10 @@
 </tr>
 </thead>
 <tr>
-<td width="20%">sourceProjectId</td> <td> <code>integer<br/><i><sub>example: 19626262</sub></i></code> <br/> Project for the live instance we want to source the command from.</td>
+<td width="20%">organizationId</td> <td> <code>string<br/><i><sub>example: 5cad178b20a1d52567b534553413b691</sub></i></code> <br/> Organization Id of the projects we would like to broadcast the command to.</td>
+</tr>
+<tr>
+<td width="20%">excludeProjectId</td> <td> <code>integer<br/><i><sub>example: 19626262</sub></i></code> <br/> Project for the live instance we want to exclude from the broadcast list. If null, all projects will be included.</td>
 </tr>
 <tr>
 <td width="20%">command</td> <td> <code>object<br/><i><sub>example: {'$type': 'OrderCommand', 'symbol': {'id': 'BTCUSD 2XR', 'value': 'BTCUSD'}, 'order_type': 'market', 'quantity': '0.1', 'limit_price': 0, 'stop_price': 0, 'tag': ''}</sub></i></code> <br/> The command to run.</td>
@@ -19,7 +22,8 @@
 <td>
 <div class="cli section-example-container"><pre>
 {
-  "sourceProjectId": 19626262,
+  "organizationId": "5cad178b20a1d52567b534553413b691",
+  "excludeProjectId": 19626262,
   "command": {
     "$type": "OrderCommand",
     "symbol": {

03 Writing Algorithms/40 Live Trading/41 Commands/07 Broadcast Commands by API.html

@@ -1,8 +1,7 @@
 <p>
 	To broadcast a command to your live algorithms, send a payload through the <a href='/docs/v2/cloud-platform/api-reference/live-management/live-commands'>QuantConnect REST API</a> or <a href='/docs/v2/lean-cli/live-trading/algorithm-control'>LEAN CLI</a>.
 	<span class='csharp'>LEAN converts the first character in each key of the payload to uppercase before injecting the data into your algorithm.</span>
-	The following script demonstrates how to broadcast a command with the REST API.
-    The source project ID is any project in your organization. It will not receive the command.
+	The following script demonstrates how to broadcast a command to all projects in your organization with the REST API.
 </p>
 
 <div class="section-example-container">
@@ -14,6 +13,7 @@
 # Edit these values:
 USER_ID = 0
 API_TOKEN = '_____'
+ORGANIZATION_ID = '_____'
 
 BASE_URL = 'https://www.quantconnect.com/api/v2/'
 
@@ -33,17 +33,17 @@
         'Timestamp': timestamp
     }
 
-def broadcast_command(source_project_id, command):
+def broadcast_command(command):
     return post(
         f'{BASE_URL}/live/commands/broadcast', 
         headers=get_headers(), 
-        json={"sourceProjectId": source_project_id, "command": command}
+        json={"organizationId": ORGANIZATION_ID, "command": command}
     ).json()
 
-# Provide your project Id and command to call the on_command event handler:
-print(broadcast_command(&lt;source_project_id&gt;, {'ticker': 'AAPL', 'quantity': 1}))
-# Provide your project Id and command with the $type to call encapsulated event handlers:
-print(broadcast_command(&lt;source_project_id&gt;, {'$type': 'MyCommand', 'ticker': 'AAPL', 'quantity': 1}))</pre>
+# Provide the command to call the on_command event handler:
+print(broadcast_command({'ticker': 'AAPL', 'quantity': 1}))
+# Provide the command with the $type to call encapsulated event handlers:
+print(broadcast_command({'$type': 'MyCommand', 'ticker': 'AAPL', 'quantity': 1}))</pre>
 </div>
 
-<p>To get your user Id and API token, see <a href='/docs/v2/cloud-platform/community/profile#09-Request-API-Token'>Request API Token</a>.</p>
+<p>To get your user Id, API token, and organization Id, see <a href='/docs/v2/cloud-platform/community/profile#09-Request-API-Token'>Request API Token</a> and <a href='/docs/v2/cloud-platform/organizations/getting-started#05-Get-Organization-Id'>Get Organization Id</a>.</p>

QuantConnect-Platform-2.0.0.yaml

@@ -2438,9 +2438,13 @@ components:
     BroadcastLiveCommandRequest:
       type: object
       properties:
-        sourceProjectId:
+        organizationId:
+          type: string
+          description: Organization Id of the projects we would like to broadcast the command to
+          example: 5cad178b20a1d52567b534553413b691
+        excludeProjectId:
           type: integer
-          description: Project for the live instance we want to source the command from.
+          description: Project for the live instance we want to exclude from the broadcast list. If null, all projects will be included.
           example: 19626262
         command:
           type: object