Sign in
latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingFaAllocationManagement

Retrieve Single Allocation Group

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.

post/iserver/account/allocation/group/single

Request body

namestring required

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.

default_method'A' | 'E' | 'N' | 'C' | 'P' | 'R' | 'S'

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