diff --git a/01 Cloud Platform/10 Live Trading/02 Brokerages/17 Bloomberg EMSX/13 Deployment Details.php b/01 Cloud Platform/10 Live Trading/02 Brokerages/17 Bloomberg EMSX/13 Deployment Details.php new file mode 100644 index 0000000000..332a71beb4 --- /dev/null +++ b/01 Cloud Platform/10 Live Trading/02 Brokerages/17 Bloomberg EMSX/13 Deployment Details.php @@ -0,0 +1,10 @@ + "The Server Auth Id, which is the unique user identifier (UUID) of the Bloomberg Anywhere user.", + "terminal-link-emsx-broker" => "The EMSX broker that receives the orders.", + "terminal-link-emsx-account" => "The EMSX account to which LEAN routes orders.", + "terminal-link-emsx-team" => "The EMSX team account that receives events of your team's orders. It's empty if you didn't set one." +]; +include(DOCS_RESOURCES."/live-trading/deployment-details.php"); +?> diff --git a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/01 Live Algorithm Statistics/03 Responses.html b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/01 Live Algorithm Statistics/03 Responses.html index 1dbca6a90d..6f24bd9ef2 100644 --- a/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/01 Live Algorithm Statistics/03 Responses.html +++ b/01 Cloud Platform/99 API Reference/07 Live Management/02 Read Live Algorithm/01 Live Algorithm Statistics/03 Responses.html @@ -56,6 +56,9 @@

200 Success

serverStatistics ServerStatistics object
Status of the node that runs the live algorithm, including its CPU and RAM usage. It's empty if the algorithm is not running. +deploymentDetails string object
Details the brokerage, data provider or any other component shares about the deployment, like account information. It's omitted if the deployment reported none. + + charts ChartSummary object
Contains the names of all charts. @@ -113,6 +116,9 @@

200 Success

"LEAN Version": "v2.5.0.0.18009", "Up Time": "0d 00:00:03" }, + "deploymentDetails": { + "key": "string" + }, "charts": { "name": "string" }, diff --git a/QuantConnect-Platform-2.0.0.yaml b/QuantConnect-Platform-2.0.0.yaml index 4d13e76fad..44f3e33eab 100644 --- a/QuantConnect-Platform-2.0.0.yaml +++ b/QuantConnect-Platform-2.0.0.yaml @@ -5331,6 +5331,13 @@ components: description: >- Status of the node that runs the live algorithm, including its CPU and RAM usage. It's empty if the algorithm is not running. + deploymentDetails: + type: object + additionalProperties: + type: string + description: >- + Details the brokerage, data provider or any other component shares about the deployment, + like account information. It's omitted if the deployment reported none. charts: $ref: '#/components/schemas/ChartSummary' description: Chart updates for the live algorithm since the last result packet. diff --git a/Resources/live-trading/deployment-details.php b/Resources/live-trading/deployment-details.php new file mode 100644 index 0000000000..0c3aa51a93 --- /dev/null +++ b/Resources/live-trading/deployment-details.php @@ -0,0 +1,35 @@ + description of each detail the brokerage shares. +?> +

When you deploy a live algorithm with , the brokerage shares some details of the deployment, like the account it trades. Use them to tell concurrent deployments apart or to check that the algorithm connected to the account you expect. The details never include credentials.

+ +

The following table describes the deployment details that shares:

+ + + + + + + + + + $description) { ?> + + + + + + +
KeyDescription
+ +

TheDeploymentDetailsdeployment_details property of your algorithm is a read-only dictionary of the details. LEAN populates it before it calls the Initializeinitialize method, so you can read it anywhere in your algorithm.

+ +
+ 
var deploymentDetails = DeploymentDetails.Select(kvp => $"{kvp.Key}:{kvp.Value}");
+Log($"deploymentDetails: {string.Join(", ", deploymentDetails)}");
+ 
deployment_details = [f'{kvp.key}:{kvp.value}' for kvp in self.deployment_details]
+self.log(f'deployment_details: {deployment_details}')
+
+ +

The /live/read API endpoint also returns the details in its deploymentDetails field, so you can read them outside of the algorithm.

diff --git a/code-generators/API-Reference-Code-Generator.py b/code-generators/API-Reference-Code-Generator.py index a0f270d34c..42c85c0004 100644 --- a/code-generators/API-Reference-Code-Generator.py +++ b/code-generators/API-Reference-Code-Generator.py @@ -547,7 +547,7 @@ def _example_additional_props(self, add_prop, ref_queue, indent): if "type" in add_prop: prop_type = self._normalize_type(add_prop["type"]) if isinstance(prop_type, str): - return f'"{prop_type}"', f"{prop_type} object" + return f'{{\n{tab} "key": "{prop_type}"\n{tab} }}', f"{prop_type} object" # dict type with format (edge case) fmt = prop_type.get("format", "") type_label = f'{prop_type}$({fmt}) object'