Skip to content

Surface the deployment details in the live read api client - #9794

Merged
Martin-Molinero merged 1 commit into
QuantConnect:masterfrom
Martin-Molinero:feature-live-read-deployment-details
Sep 15, 2026
Merged

Martin-Molinero merged 1 commit into
QuantConnect:masterfrom
Martin-Molinero:feature-live-read-deployment-details

Conversation

@Martin-Molinero

@Martin-Molinero Martin-Molinero commented Sep 15, 2026

Copy link
Copy Markdown
Member

Description

LiveAlgorithmResults now carries the deploymentDetails the live/read endpoint reports, deserialized alongside the runtime and server statistics that sit next to it in the same response.

The field is optional and backwards compatible: the converter's dictionary helper returns null when the key is absent or is not an object, so deployments running an older Lean, or whose brokerage and data queue handlers share nothing, simply leave it null. Covered by tests.

Renames the converter's private DeserializeStatistics helper to DeserializeDictionary, since it is no longer used only for statistics.

Depends on the API server reporting the field, which is a separate change. Nothing breaks while it does not.

Related Issue

#9792

Motivation and Context

Completes the deployment details feature on the client side. QCAlgorithm.DeploymentDetails exposes them to a running algorithm and AlgorithmConfiguration.DeploymentDetails stores them in the results, but a client reading a live deployment through the API had no way to see them, since the live read response is built field by field.

Requires Documentation Change

LiveAlgorithmResults.DeploymentDetails

How Has This Been Tested?

New LiveAlgorithmResultsJsonConverterTests: the field present in camelCase and in PascalCase, the field absent entirely with everything else still deserializing, and a regression case for the server statistics that share the renamed helper.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which improves implementation)
  • Performance (non-breaking change which improves performance. Please add associated performance test and results)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-functional change (xml comments/documentation/etc)

Checklist:

  • My code follows the code style of this project.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My branch follows the naming convention bug-<issue#>-<description> or feature-<issue#>-<description>

🤖 Generated with Claude Code

LiveAlgorithmResults now carries the deploymentDetails the live/read endpoint
reports, deserialized like the runtime and server statistics next to it. The
field is optional: deployments running an older Lean, or whose brokerage and
data queue handlers share none, report nothing and it stays null.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01N792RJ2EcZBDXhbe3KRLLq
@Martin-Molinero
Martin-Molinero merged commit f9107ab into QuantConnect:master Sep 15, 2026
7 of 8 checks passed
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