listAccounts
List Accounts - retrieves accounts for a specific user with optional data.
Authentication: required
List Accounts - retrieves accounts for a specific user with optional data.
This handler returns all accounts where the specified user is either the owner
or a collaborator. It supports optional inclusion of computed balances, crypto
holdings, and Plaid access object data.
Computed balance invariant: each account's computedBalance is the sum of its
non-deleted transactions expressed in that account's own currency. A transaction
denominated in a different currency (Plaid isoCurrencyCode) is converted to the
account currency using the latest USD-normalized fiat rate before summing.
Negative amounts (refunds/reversals) sum naturally. If a required rate is
unavailable the request fails rather than returning a mixed-currency sum.
Authentication: Required (Bearer token)
Parameters:
- userID (string, required): ID of the user whose accounts to retrieve
- includeComputedBalance (boolean, optional): Include computed account balances
- includeCryptoHoldings (boolean, optional): Include crypto holdings for crypto accounts
- includePlaidAccessObject (boolean, optional): Include Plaid integration data
Returns:
- accounts (array): Array of AccountWithCryptoHoldings objects
Example:
{
"method": "listAccounts",
"params": {
"userID": "user123",
"includeComputedBalance": true,
"includeCryptoHoldings": true,
"includePlaidAccessObject": true
}
}