Skip to content

Document deployment details for Terminal Link - #2680

Merged
AlexCatarino merged 2 commits into
QuantConnect:masterfrom
AlexCatarino:feature-9792-deployment-details
Sep 15, 2026
Merged

AlexCatarino merged 2 commits into
QuantConnect:masterfrom
AlexCatarino:feature-9792-deployment-details

Conversation

@AlexCatarino

Copy link
Copy Markdown
Member

Summary

LEAN now exposes the details a brokerage shares about a live deployment through QCAlgorithm.DeploymentDetails / self.deployment_details (QuantConnect/Lean#9792) and the /live/read endpoint (QuantConnect/Lean#9794). Terminal Link is the first brokerage to share them (Lean.Brokerages.TerminalLink@0688390).

  • Add 13 Deployment Details to the Bloomberg EMSX brokerage section with the four terminal-link-* keys and how to read them from the algorithm and the API.
  • The page is a thin wrapper over a new Resources/live-trading/deployment-details.php include, so other brokerages only need to supply their own key table when they start sharing details.
  • Add the deploymentDetails field to the /live/read API reference and fix the API reference generator so a string dictionary renders as an object instead of a bare "string".

Test plan

  • Rendered the new page with PHP and checked the table, code samples and links.
  • Ran python code-generators/API-Reference-Code-Generator.py; only the live/read Responses page changed.

AlexCatarino and others added 2 commits September 15, 2026 16:06
Add a Deployment Details page to the Bloomberg EMSX brokerage docs, built
from a shared Resources include so other brokerages only need to supply
their own key table. Add the deploymentDetails field to the live/read API
reference and fix the generator so a string dictionary renders as an object.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@AlexCatarino
AlexCatarino merged commit f136a7d into QuantConnect:master Sep 15, 2026
1 check passed
@AlexCatarino
AlexCatarino deleted the feature-9792-deployment-details branch September 15, 2026 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant