List All Accounts

View as MarkdownOpen in Claude
return accounts

Response

returned array with user account
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 or null

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

accountIdstring
Indicates the identifying number for the account.
accountStatuslong
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).

businessTypeenum
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.

clearingStatusenum
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.
currencyenum
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.
ibEntityenum
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.
parentobject

Describes account relations in partitioned or multiplexed (segemented) account structures.

trackVirtualFXPortfolioboolean
Indicates that virtual forex positions are tracked in the account.
tradingTypeenum
Internal identifier used by IB to reflect the trading permissions of the account.
typeenum
Indicates whether the account exists in production, paper, or demo environments.

Errors

401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error