API ReferenceTradingTrading Fa Allocation Management

Request Model Summary

View as MarkdownOpen in Claude
Request a summary for a single model.

Request

This endpoint expects an object.
reqIDlongOptional
Request identifier to uniquely track a request.
modelstringOptional
Name of your model.

Response

Successfully retrieve model summary.
bootstrappedbooleanOptional
Used internally for client portal designation. Should be ignored.
customIndexbooleanOptional
Used internally for client portal. Should be ignored.
descstringOptional
Personal description of model to read in IBKR GUI elements.
isStaticbooleanOptional

Determine if investing and rebalancing should be handled statically or dynamically. * true - Static models will always use the original targets. * false - Dynamic models will adjust allocation in response to market movements.

mismatchbooleanOptional
Notes if the Actual allocation has become misalligned with the Target.
modelstringOptional
Name of the model.
nlvdoubleOptional
Net Liquidation of the model.
numAccountslongOptional
Lists the number of accounts held within the model.
reqIDlongOptional
Request identifier to uniquely track a request.
subscriptionStatuslongOptional
Describes if the model is in polling mode.

Errors

401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error