---
title: "Portfolio Subaccounts (Large Account Structures)"
method: GET
path: "/portfolio/subaccounts2"
tags: ["tradingPortfolio"]
---

# Portfolio Subaccounts (Large Account Structures)

`GET /portfolio/subaccounts2`

Used in tiered account structures (such as Financial Advisor and IBroker Accounts) to return a list of sub-accounts, paginated up to 20 accounts per page, for which the user can view position and account-related information.  This endpoint must be called prior to calling other /portfolio endpoints for those sub-accounts. If you have less than 100 sub-accounts use /portfolio/subaccounts.  To query a list of accounts the user can trade, see /iserver/accounts.

## Path parameters

- `accountId` string, required

## Query parameters

- `nocache` boolean

## Response `200`

response with subaccount definitions

- Subaccounts2Response
  - `metadata` Subaccounts2ResponseMetadata — Metadata container describing the subaccounts.
    - `pageNum` integer — The active page number.
    - `pageSize` integer — Items contained in the returning page.
    - `total` integer — The total number of accounts returned for the page.
  - `subaccounts` AccountAttributes[] — List containing all subaccounts of the account structure.
    - `PrepaidCrypto-P` boolean — Indicates whether account has a prepaid crypto segment (Crypto Plus) with PAXOS.
    - `PrepaidCrypto-Z` boolean — Indicates whether account has a prepaid crypto segment (Crypto Plus) with ZEROHASH.
    - `accountAlias` string, nullable — User-defined alias assigned to the account for easy identification.
    - `accountId` string — Indicates the identifying number for the account.
    - `accountStatus` integer — Unix epoch timestamp of account opening.
    - `accountTitle` string — A name assigned to the account, typically the account holder name or business entity.
    - `accountVan` string — The account's virtual account number, or otherwise its IB accountId if no VAN is set.
    - `acctCustType` string — Identifies the type of client with which the account is associated, such as an individual or LLC.
    - `brokerageAccess` boolean — 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.
    - `category` string — 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.
    - `covestor` boolean — 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.
    - `desc` string — Internal human-readable description of the account.
    - `displayName` string — Displayed name of the account in UI. Will reflect either the accountId or accountAlias, if set.
    - `faClient` boolean — 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.
    - `id` string — The account's IB accountId.
    - `noClientTrading` boolean — Indicates that trading by the client is disabled in the account.
    - `parent` AccountAttributesParent — Describes account relations in partitioned or multiplexed (segemented) account structures.
      - `accountId` string — Account ID of the parent account in a multiplex account structure.
      - `isMChild` boolean — Indicates that the given account is a multiplex child account.
      - `isMParent` boolean — Indicates that the given account is itself a multiplex parent account.
      - `isMultiplex` boolean — Indicates that the account is a multiplex account.
      - `mmc` unknown[] — Money manager client.
        - unknown
    - `trackVirtualFXPortfolio` boolean — 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.

## Other responses

- `401` — Missing, invalid, or unparseable Authorization token.
- `500` — internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests. For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.
- `503` — service is unavailable. For example if request takes more than 10s due to some internal service unavailability, request aborted and this status returned

---

[API](https://skmtc.net/interactivebrokers/apis/api-reference.md) · [All operations](https://skmtc.net/interactivebrokers/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactivebrokers/api-reference/revisions/67f9f562c2c6/schema)