API ReferenceTrading Fa Allocation Management

Set Allocation Preset

View as MarkdownOpen in Claude
Set the preset behavior for new allocation groups for specific events.

Request

This endpoint expects an object.
group_auto_close_positionsbooleanOptional
Determines if allocation groups should prioritize closing positions over equal distribution.
default_method_for_allenumOptional

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_positionsbooleanOptional
Determines if allocation profiles should prioritize closing positions over equal distribution.
strict_credit_checkbooleanOptional
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_allocationbooleanOptional
Determines if the system should keep allocation groups proportional for scaling.

Response

Successfully retrieve preset details
successboolean
Signifies that the request was successfully submitted.

Errors

401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error