Document TerminalLink IsCfdTrade and AdditionalProperties - #2619
Merged
AlexCatarino merged 1 commit intoAug 13, 2026
Merged
Conversation
…rties Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents the order properties added by QuantConnect/Lean#9689.
Resources/brokerages/terminal-link/orders.php, shared by the Writing Algorithms and Cloud Platform pages):IsCfdTrade: books the order as a contract for differences instead of a regular trade. It maps to the CFD option of the Booking Type drop-down on the EMSX trading ticket, setsEMSX_CFD_FLAGat the order level, and defaults tofalse, which is the EMSX default and the value for which the brokerage sends no element.AdditionalProperties: a dictionary of EMSX element name to value, for elements no dedicated property covers. The dedicated properties take precedence, and elements the EMSX schema doesn't define are skipped rather than rejecting the order.dict, so entries go in one by one,updatebulk loads them andclearresets them.FixOrderProperties.AdditionalPropertiestoBaseExtendedDictionary<string, string>, so the data type and default value cells are updated and the same Python note follows the existing example.The
AdditionalPropertiespassthrough reaches the wire once QuantConnect/Lean.Brokerages.TerminalLink#136 merges and a newQuantConnect.Brokeragespackage ships;IsCfdTradeis documented from the same behavior.Test Plan
php -l Resources/brokerages/terminal-link/orders.phpreports no syntax errors.$writingAlgorithmsguard so the Cloud Platform page stays code free.