List All Accounts

GET

/portfolio/accounts

GET

/portfolio/accounts

$ curl https://api.ibkr.com/portfolio/accounts

1 [
2   {
3     "PrepaidCrypto-P": false,
4     "PrepaidCrypto-Z": false,
5     "accountAlias": null,
6     "accountId": "DU123456",
7     "accountStatus": 1590724800000,
8     "accountTitle": "John Smith, LLC",
9     "accountVan": "DU123456",
10     "acctCustType": "LLC",
11     "brokerageAccess": true,
12     "businessType": "IB_SALES",
13     "category": "",
14     "clearingStatus": "O",
15     "covestor": false,
16     "currency": "USD",
17     "desc": "DU123456",
18     "displayName": "John Smith, LLC",
19     "ibEntity": "IBLLC-US",
20     "id": "DU123456",
21     "noClientTrading": false,
22     "parent": {
23       "accountId": "",
24       "isMChild": false,
25       "isMParent": false,
26       "isMultiplex": false,
27       "mmc": []
28     },
29     "trackVirtualFXPortfolio": true,
30     "tradingType": "STKNOPT",
31     "type": "DEMO",
32     "faclient": false
33   }
34 ]

return accounts

Response

returned array with user account

PrepaidCrypto-PbooleanOptional

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

PrepaidCrypto-ZbooleanOptional

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

accountAliasstring or nullOptional

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

accountIdstringOptional

Indicates the identifying number for the account.

accountStatuslongOptional

Unix epoch timestamp of account opening.

accountTitlestringOptional

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

accountVanstringOptional

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

acctCustTypestringOptional

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

brokerageAccessbooleanOptional

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

businessTypeenumOptional

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

categorystringOptional

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

clearingStatusenumOptional

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

covestorbooleanOptional

Indicates a Covestor account.

currencyenumOptional

Base currency of the account.

descstringOptional

Internal human-readable description of the account.

displayNamestringOptional

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

faClientbooleanOptional

Indicates that the account is managed by a financial advisor.

ibEntityenumOptional

IB business entity under which the account resides.

idstringOptional

The account's IB accountId.

noClientTradingbooleanOptional

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

parentobjectOptional

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

trackVirtualFXPortfoliobooleanOptional

Indicates that virtual forex positions are tracked in the account.

tradingTypeenumOptional

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

typeenumOptional

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

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error