API ReferenceTrading Fa Allocation Management

Retrieve Single Allocation Group

View as MarkdownOpen in Claude
Retrieves the configuration of a single account group. This describes the name of the allocation group, the specific accounts contained in the group, and the allocation method in use along with any relevant quantities. This endpoint is only supported for Financial Advisors and IBroker Accounts.

Request

This endpoint expects an object.
namestringRequired
Name of an existing allocation group.

Response

Returns details of the allocation group.
namestring
Name used to refer to your allocation group. This will be used while placing orders.
accountslist of objects

Contains a series of objects depicting which accounts are involved and, for user-defined allocation methods, the distribution value for each sub-account.

default_methodenumDefaults to N

Interactive Brokers supports two forms of allocation methods. Allocation methods that have calculations completed by Interactive Brokers, and a set of allocation methods calculated by the user and then specified. IB-computed allocation methods:

  • A - Available Equity
  • E - Equal
  • N - Net Liquidation Value

User-specified allocation methods:

  • C - Cash Quantity
  • P - Percentage
  • R - Ratios
  • S - Shares

Errors

401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error