Sign in
latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingFaAllocationManagement

Modify Allocation Group

Modify an existing allocation group.

put/iserver/account/allocation/group

Request body

namestring required

Name used to refer to your allocation group. If prev_name is specified, this will become the new name of the group.

prev_namestring

Can be used to rename a group. Using this field will recognize the previous name, while the "name" filed will mark the updated name.

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

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

Response

Returns a confirmation that the modification was successful.

successboolean