Portfolio Subaccounts (Large Account Structures)

GET

/v1/api/portfolio/subaccounts2

GET

/v1/api/portfolio/subaccounts2

curl https://localhost:5000/v1/api/portfolio/subaccounts2 \
     -H "Authorization: Bearer <token>"

{
  "metadata": {
    "pageNum": 0,
    "pageSize": 20,
    "total": 1
  },
  "subaccounts": [
    {
      "PrepaidCrypto-P": false,
      "PrepaidCrypto-Z": false,
      "accountAlias": "None",
      "accountId": "U1234567",
      "accountStatus": 1644814800000,
      "accountTitle": "",
      "accountVan": "U1234567",
      "acctCustType": "LLC",
      "brokerageAccess": false,
      "businessType": "IB_PROSERVE",
      "category": "",
      "clearingStatus": "O",
      "covestor": false,
      "currency": "USD",
      "desc": "U1234567",
      "displayName": "U1234567",
      "ibEntity": "IBLLC-US",
      "id": "U1234567",
      "noClientTrading": false,
      "parent": {
        "accountId": "",
        "isMChild": false,
        "isMParent": false,
        "isMultiplex": false,
        "mmc": []
      },
      "trackVirtualFXPortfolio": true,
      "tradingType": "PMRGN",
      "type": "DEMO",
      "faclient": false
    }
  ]
}

Used in tiered account structures (such as Financial Advisor and IBroker Accounts) to return a list of sub-accounts, paginated up to 1000 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.

Authentication

AuthorizationBearer

SSO bearer token.

Path parameters

accountIdstringRequired

Query parameters

nocachebooleanOptionalDefaults to false

pagelongOptional>=0

pageSizelongOptional1-1000Defaults to 20

Response

response with subaccount definitions

metadataobjectOptional

Metadata container describing the subaccounts.

subaccountslist of objectsOptional

List containing all subaccounts of the account structure.

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error