Skip to content

Document unified Interactive Brokers Financial Advisor workflows - Feature 2624 fav2 #2679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Farrell-A wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Document unified Interactive Brokers Financial Advisor workflows - Feature 2624 fav2 #2679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4edc2e3
Document unified Financial Advisor account services
codex Aug 13, 2026
86e6448
Correct Interactive Brokers FA routing guidance
codex Aug 13, 2026
de45f07
Clarify Financial Advisor lifecycle and scope
codex Aug 13, 2026
5a33cf7
Align FA documentation with runtime behavior
codex Sep 10, 2026
1fb9e2e
Restore FA account identification guidance
codex Sep 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions 03 Writing Algorithms/22 Trading and Orders/09 Order Properties/99 Examples.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@ <h4>Example 1: Extended Market Hour Orders</h4>
self._last_price = self.securities[self._spy].price</pre>
</div>

<h4>Example 2: Financial Advisor Managing Client Funds</h4>
<p>The following algorithm forms an equal-weight portfolio at the start of each week with the 10 most liquid US Equities. It demonstrates how order properties can give <a href='https://www.quantconnect.com/docs/v2/writing-algorithms/trading-and-orders/financial-advisors'>financial advisors</a> easy control over client funds.</p>
<h4>Example 2: Financial Advisor Group Routing</h4>
<p>The following algorithm targets an aggregate equal-weight portfolio of 10 liquid US Equities and routes its orders to an Interactive Brokers Allocation Group saved with the <code>Equal</code> method. <code class="csharp">SetHoldings</code><code class="python">set_holdings</code> sizes each aggregate parent order; IB applies the saved method to its managed accounts. Use <a href="/docs/v2/writing-algorithms/trading-and-orders/financial-advisors#05-Account-Snapshots">account snapshots</a> for per-account state.</p>
<div class="section-example-container testable">
<pre class="csharp">public class OrderPropertiesAlgorithm : QCAlgorithm
{
Expand All @@ -121,8 +121,7 @@ <h4>Example 2: Financial Advisor Managing Client Funds</h4>
DefaultOrderProperties = new InteractiveBrokersOrderProperties
{
FaGroup = "TestGroupEQ", // FA group
FaMethod = "NetLiq", // Allocation by net liquidation
Account = "FA123456" // FA account
FaMethod = "Equal" // Match the group's saved method
};

// Add a universe that selects the 10 most liquid US Equities at the start of each week.
Expand Down Expand Up @@ -151,9 +150,8 @@ <h4>Example 2: Financial Advisor Managing Client Funds</h4>

# Define the order properties to trade with an FA group.
self.default_order_properties = InteractiveBrokersOrderProperties()
self.default_order_properties.fa_group = "TestGroupEQ" # FA group
self.default_order_properties.fa_method = "EqualQuantity" # Allocation by net liquidation
self.default_order_properties.account = "DU123456" # FA account
self.default_order_properties.fa_group = "TestGroupEQ" # FA group
self.default_order_properties.fa_method = "Equal" # Match the saved method

# Add a universe that selects the 10 most liquid US Equities at the start of each week.
spy = Symbol.create('SPY', SecurityType.EQUITY, Market.USA)
Expand Down
1 change: 1 addition & 0 deletions 03 Writing Algorithms/22 Trading and Orders/14 Financial Advisors/05 Account Snapshots.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/account-snapshots.html"); ?>
1 change: 1 addition & 0 deletions 03 Writing Algorithms/22 Trading and Orders/14 Financial Advisors/06 Group Assignments.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/group-assignments.html"); ?>
1 change: 1 addition & 0 deletions 03 Writing Algorithms/22 Trading and Orders/14 Financial Advisors/07 Allocation Updates.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/allocation-updates.html"); ?>
1 change: 1 addition & 0 deletions ...gorithms/22 Trading and Orders/14 Financial Advisors/08 Configuration and Limitations.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/configuration-and-limitations.html"); ?>
1 change: 1 addition & 0 deletions 03 Writing Algorithms/22 Trading and Orders/14 Financial Advisors/09 Examples.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/examples.html"); ?>
6 changes: 3 additions & 3 deletions 03 Writing Algorithms/22 Trading and Orders/14 Financial Advisors/metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"type": "metadata",
"values": {
"description": "Financial Advisor accounts enable certified professionals to use a single trading algorithm to manage several client accounts.",
"keywords": "Interactive Brokers integration, Financial Advisor accounts, Financial Advisor group orders, manage client accounts, Account Groups in Trader Workstation, allocation methods, net liquidation value of each account",
"og:description": "Financial Advisor accounts enable certified professionals to use a single trading algorithm to manage several client accounts.",
"description": "Financial Advisor accounts let you monitor managed accounts, route group orders, and manage existing IB Allocation Groups from one algorithm.",
"keywords": "Interactive Brokers integration, Financial Advisor accounts, Financial Advisor group orders, brokerage account snapshots, managed account state, Account Groups in Trader Workstation, group assignments, allocation updates, allocation methods, Financial Advisor examples",
"og:description": "Financial Advisor accounts let you monitor managed accounts, route group orders, and manage existing IB Allocation Groups from one algorithm.",
"og:title": "Financial Advisors - Documentation QuantConnect.com",
"og:type": "website",
"og:site_name": "Financial Advisors - QuantConnect.com",
Expand Down
4 changes: 3 additions & 1 deletion ...deling/05 Brokerages/02 Supported Models/02 Interactive Brokers/18 Financial Advisors.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<p><a rel='nofollow' target='_blank' href='https://qnt.co/interactivebrokers'>IB</a> supports FA accounts for Trading Firm and Institution organizations. FA accounts enable certified professionals to use a single trading algorithm to manage several client accounts.</p>
<p><a rel='nofollow' target='_blank' href='https://qnt.co/interactivebrokers'>IB</a> supports FA accounts for Trading Firm or Institution organizations. FA accounts enable certified professionals to use a single trading algorithm to manage several client accounts.</p>

<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/place-fa-orders.html"); ?>

<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/allocation-methods.html"); ?>

<p>For account snapshots, asynchronous group management, configuration, and operational limitations, see the complete <a href="/docs/v2/writing-algorithms/trading-and-orders/financial-advisors">Financial Advisors guide</a>.</p>
1 change: 1 addition & 0 deletions ...thms/40 Live Trading/04 Trading and Orders/14 Financial Advisors/05 Account Snapshots.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/account-snapshots.html"); ?>
1 change: 1 addition & 0 deletions ...thms/40 Live Trading/04 Trading and Orders/14 Financial Advisors/06 Group Assignments.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/group-assignments.html"); ?>
1 change: 1 addition & 0 deletions ...hms/40 Live Trading/04 Trading and Orders/14 Financial Advisors/07 Allocation Updates.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/allocation-updates.html"); ?>
1 change: 1 addition & 0 deletions ... Trading/04 Trading and Orders/14 Financial Advisors/08 Configuration and Limitations.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/configuration-and-limitations.html"); ?>
1 change: 1 addition & 0 deletions ...ng Algorithms/40 Live Trading/04 Trading and Orders/14 Financial Advisors/09 Examples.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php echo file_get_contents(DOCS_RESOURCES."/order-types/financial-advisors/examples.html"); ?>
6 changes: 3 additions & 3 deletions ...ting Algorithms/40 Live Trading/04 Trading and Orders/14 Financial Advisors/metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"type": "metadata",
"values": {
"description": "Financial Advisor accounts enable certified professionals to use a single trading algorithm to manage several client accounts.",
"keywords": "Interactive Brokers, Financial Advisor group order, Account Groups in Trader Workstation, Allocation Methods, net liquidation value, organization tier",
"og:description": "Financial Advisor accounts enable certified professionals to use a single trading algorithm to manage several client accounts.",
"description": "Financial Advisor accounts let you monitor managed accounts, route group orders, and manage existing IB Allocation Groups from one algorithm.",
"keywords": "Interactive Brokers, Financial Advisor group orders, brokerage account snapshots, managed account state, Account Groups in Trader Workstation, group assignments, allocation updates, allocation methods, Financial Advisor examples, organization tier",
"og:description": "Financial Advisor accounts let you monitor managed accounts, route group orders, and manage existing IB Allocation Groups from one algorithm.",
"og:title": "Financial Advisors - Documentation QuantConnect.com",
"og:type": "website",
"og:site_name": "Financial Advisors - QuantConnect.com",
Expand Down
4 changes: 2 additions & 2 deletions Resources/brokerages/interactive-brokers/orders.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@

<h4>Order Properties</h4>

<p><?= $writingAlgorithms ? "The <code>InteractiveBrokersBrokerageModel</code> supports custom order properties." : "We model custom order properties from the IB API." ?> The following table describes the members of the <code>InteractiveBrokersOrderProperties</code> object that you can set to customize order execution. The table does not include the <a href='/docs/v2/writing-algorithms/reality-modeling/brokerages/supported-models/interactive-brokers#18-Financial-Advisors'>methods for FA accounts</a>.</p>
<p><?= $writingAlgorithms ? "The <code>InteractiveBrokersBrokerageModel</code> supports custom order properties." : "We model custom order properties from the IB API." ?> The following table describes the general members of the <code>InteractiveBrokersOrderProperties</code> object that you can set to customize order execution. For FA-specific routing and percentage properties, see <a href='/docs/v2/writing-algorithms/trading-and-orders/financial-advisors#02-Group-Routing'>Group Routing</a> and <a href='/docs/v2/writing-algorithms/trading-and-orders/financial-advisors#03-Allocation-Methods'>Allocation Methods</a>.</p>

<table class="table qc-table">
<thead>
Expand Down Expand Up @@ -353,7 +353,7 @@


<h4>Financial Advisor Group Orders</h4>
<p>To place FA group orders, see <a href='/docs/v2/writing-algorithms/reality-modeling/brokerages/supported-models/interactive-brokers#18-Financial-Advisors'>Financial Advisors</a>.</p>
<p>To place direct managed-account and FA group orders, see <a href='/docs/v2/writing-algorithms/trading-and-orders/financial-advisors'>Financial Advisors</a>.</p>

<h4>Fractional Trading</h4>
<p>The <?= $writingAlgorithms ? "<code>InteractiveBrokersBrokerageModel</code> doesn't" : "IB API and FIX/CTCI don't" ?> support <a rel="nofollow" target="_blank" href='https://www.interactivebrokers.com/en/trading/fractional-trading.php'>fractional trading</a>.</p>
Expand Down
Loading