Skip to navigation
API ReferenceTradingTrading Fa Allocation Management

Add Allocation Group

View as MarkdownOpen in Claude

Add a new allocation group. This group can be used to trade in place of the {accountId} for the /v1/api/iserver/account/{accountId}/orders endpoint.

Authentication

AuthorizationBearer
SSO bearer token.

Request

This endpoint expects an object.
namestringRequired

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

accountslist of objectsRequired

An array of accounts that should be held in the allocation group and, if using a User-specified allocaiton method, the value correlated to the allocation.

default_methodenumRequiredDefaults 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

Response

Returns a confirmation that the modification was successful.
successbooleanOptional

Errors

401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error