Skip to content

Document Public brokerage#2583

Merged
AlexCatarino merged 5 commits into
QuantConnect:masterfrom
AlexCatarino:document-public-brokerage
Jul 10, 2026
Merged

Document Public brokerage#2583
AlexCatarino merged 5 commits into
QuantConnect:masterfrom
AlexCatarino:document-public-brokerage

Conversation

@AlexCatarino

Copy link
Copy Markdown
Member

Summary

Adds documentation for the Public brokerage integration (Lean PR #9543, Lean PR #9549, lean-cli PR #651), following the structure of #2462 (Webull).

Public supports US Equities, Equity Options, Index Options, and Crypto with 5 order types, so it is placed after Tastytrade and before Alpaca (position 05); Alpaca moves to the pre-existing gap at 06, so no other section renumbers.

  • New Cloud Platform brokerage section: 01 Cloud Platform/10 Live Trading/02 Brokerages/05 Public (17 pages incl. Rate Limit, Margin, and Troubleshooting from the integration's restrictions doc).
  • New brokerage model section: 03 Writing Algorithms/24 Reality Modeling/05 Brokerages/02 Supported Models/05 Public.
  • New PublicFeeModel page at 04 Transaction Fees/02 Supported Models/15 Public Model.html (alphabetical slot); Samco through Zerodha shift up one and the four affected fee anchors are updated.
  • New Lean CLI section: 05 Lean CLI/09 Live Trading/01 Brokerages/05 Public, incl. a Data Provider page for the historical-data limits (Trade data; minute = current day, hour = one month, daily = ~18y Equity / ~12y Crypto).
  • Shared partials in Resources/brokerages/public and entries in the CLI deployment wizard lists, CLI Supported Brokerages table, QuantConnect-Platform-2.0.0.yaml, and the Create Live Algorithm API reference.
  • 05 Lean CLI/99 API Reference regenerated with Lean-CLI-API-Reference-Code-Generator.py (separate commit).

Order/fee facts match Lean.Brokerages.Public (source of truth): market/limit/stop-market/stop-limit on all assets, combo limit on options only, no combo updates, extended session limit-only, DAY/GTD time in force with GTC sent as GTD+90 days, UseMargin/OutsideRegularTradingHours order properties, and the tiered crypto fee schedule.

Test Plan

  • python -c "import yaml; yaml.safe_load(...)" passes on QuantConnect-Platform-2.0.0.yaml.
  • python url_check.py: the only errors involving these pages are the not-yet-deployed /docs/v2/... Public URLs (resolve on deploy) and the private Lean.Brokerages.Public repo link, which is commented out like Webull's.
  • All DOCS_RESOURCES includes referenced by the new pages exist; renumbered sections are contiguous and match the 00.json keys.

@AlexCatarino
AlexCatarino merged commit c00363e into QuantConnect:master Jul 10, 2026
1 check passed
@AlexCatarino
AlexCatarino deleted the document-public-brokerage branch July 10, 2026 20:38
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