latestOpenAPI 3.1.02026-08-22181751733.6 KB

67f9f562c2c6

tradingPortfolio

List All Subaccounts

Retrieve attributes of the subaccounts in the account structure.

get/portfolio/subaccounts

Response

Array of objects representing accounts in the structure.

PrepaidCrypto-Pboolean

Indicates whether account has a prepaid crypto segment (Crypto Plus) with PAXOS.

PrepaidCrypto-Zboolean

Indicates whether account has a prepaid crypto segment (Crypto Plus) with ZEROHASH.

accountAliasstring nullable

User-defined alias assigned to the account for easy identification.

accountIdstring

Indicates the identifying number for the account.

accountStatusinteger

Unix epoch timestamp of account opening.

accountTitlestring

A name assigned to the account, typically the account holder name or business entity.

accountVanstring

The account's virtual account number, or otherwise its IB accountId if no VAN is set.

acctCustTypestring

Identifies the type of client with which the account is associated, such as an individual or LLC.

brokerageAccessboolean

Indicates whether account can receive live orders (do not mix with paper trading).

businessType'IB_SALES' | 'IB_PROSERVE' | 'FA' | 'FA_CLIENT' | 'INTR_BROK' | 'INTR_BROK_CLIENT' | 'FD_CLIENT' | 'INSTITUTIONAL' | 'IB_DEVELOPERS'

A descriptor of the nature of the account, reflecting the responsible group within IB.

categorystring

Designated account category. Only used in non-standard account structures.

clearingStatus'A' | 'N' | 'O' | 'C' | 'P' | 'R' | 'E' | 'Q'

Status of the account with respect to clearing at IB. O is open, P pending, N new, A abandoned, C closed, R rejected.

covestorboolean

Indicates a Covestor account.

currency'AED' | 'AUD' | 'CAD' | 'CHF' | 'CNH' | 'CZK' | 'DKK' | 'EUR' | 'GBP' | 'HKD' | 'HUF' | 'ILS' | 'JPY' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'SEK' | 'SGD' | 'USD'

Base currency of the account.

descstring

Internal human-readable description of the account.

displayNamestring

Displayed name of the account in UI. Will reflect either the accountId or accountAlias, if set.

faClientboolean

Indicates that the account is managed by a financial advisor.

ibEntity'IBLLC-US' | 'IB-CAN' | 'IB-UK' | 'IB-IE' | 'IB-AU' | 'IB-HK' | 'IB-IN' | 'IB-JP' | 'IB-SG'

IB business entity under which the account resides.

idstring

The account's IB accountId.

noClientTradingboolean

Indicates that trading by the client is disabled in the account.

trackVirtualFXPortfolioboolean

Indicates that virtual forex positions are tracked in the account.

tradingType'IRAMRGN' | 'FUTNOPT' | 'GPMRGN' | 'PMRGN' | 'STKCASH' | 'STKMRGN' | 'STKNOPT'

Internal identifier used by IB to reflect the trading permissions of the account.

type'DEMO' | 'DEMO-BROKER' | 'DEMO-ADVISOR' | 'FNF' | 'INDIVIDUAL' | 'COMPANY' | 'STL' | 'UTMA' | 'PRO-ADV' | 'IRA' | 'TRUST'

Indicates whether the account exists in production, paper, or demo environments.