Sign in
latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingFaAllocationManagement

Retrieve Allocation Presets

Retrieve the preset behavior for allocation groups for specific events. This endpoint is only supported for Financial Advisors and IBroker Accounts.

get/iserver/account/allocation/presets

Response

Successfully retrieve preset details

group_auto_close_positionsboolean

Determines if allocation groups should prioritize closing positions over equal distribution.

default_method_for_all'AvailableEquity' | '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
profiles_auto_close_positionsboolean

Determines if allocation profiles should prioritize closing positions over equal distribution.

strict_credit_checkboolean

Determines if the system should always check user credit before beginning the order process every time, or only at the time of order placement and execution.

group_proportional_allocationboolean

Determines if the system should keep allocation groups proportional for scaling.