Altruist

Altruist Account Balance API

Account data and operations

Documentation GitHub OpenAPI

Operations 4

GET /api/v1/orgs/{orgId}/households/{householdId}/accounts/{accountId}/aggregateRetirementTransactions Get aggregated retirement account transactions #

GET /api/v1/orgs/{orgId}/households/{householdId}/accounts/{accountId}/cashBalance Get cash balance summary for an account #

GET /api/v1/orgs/{orgId}/households/{householdId}/accounts/{accountId}/mma Get MMA settings for an account #

GET /api/v1/orgs/{orgId}/households/{householdId}/aggregateRetirementTransactions Get aggregated retirement account transactions #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/altruist/openapi/altruist-account-balance-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/altruist:altruist-account-balance-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Enterprise Realtime Account Balance API
  description: The Enterprise Realtime API service acts as the public API layer for advisor infrastructure, enabling partner-developers to programmatically perform advisor actions.
  version: v1
servers:
- url: https://integrations.altruist.com
  description: API Server
tags:
- name: Account Balance
  description: Account data and operations
paths:
  /api/v1/orgs/{orgId}/households/{householdId}/accounts/{accountId}/aggregateRetirementTransactions:
    get:
      tags:
      - Account Balance
      summary: Get aggregated retirement account transactions
      description: Returns aggregated IRA/retirement transaction data including distributions, contributions, RMDs, and scheduled transfers for the specified tax year
      operationId: getAggregatedTransactions_1
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: householdId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: taxYear
        in: query
        description: Tax year (defaults to current year)
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AggregatedTxnInfoV1'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Unprocessable Entity
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '501':
          description: Not Implemented
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '502':
          description: Bad Gateway
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
  /api/v1/orgs/{orgId}/households/{householdId}/accounts/{accountId}/cashBalance:
    get:
      tags:
      - Account Balance
      summary: Get cash balance summary for an account
      description: Summary aggregate of cash positions, available cash balance, and pending transactions for an account
      operationId: getCashSummary
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: householdId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CashBalanceV1'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Unprocessable Entity
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '501':
          description: Not Implemented
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '502':
          description: Bad Gateway
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
  /api/v1/orgs/{orgId}/households/{householdId}/accounts/{accountId}/mma:
    get:
      tags:
      - Account Balance
      summary: Get MMA settings for an account
      description: Retrieves Money Movement Authorization opt-in/out settings for an account
      operationId: getMmaSettings
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: householdId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/MmaSettingsV1'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Unprocessable Entity
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '501':
          description: Not Implemented
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '502':
          description: Bad Gateway
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
  /api/v1/orgs/{orgId}/households/{householdId}/aggregateRetirementTransactions:
    get:
      tags:
      - Account Balance
      summary: Get aggregated retirement account transactions
      description: Returns paginated aggregated IRA/retirement transaction data including distributions, contributions, RMDs, and scheduled transfers for the specified tax year
      operationId: getAggregatedTransactions
      parameters:
      - name: orgId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: householdId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: taxYear
        in: query
        description: Tax year (defaults to current year)
        required: false
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        description: Page number (1-indexed)
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: size
        in: query
        description: Page size
        required: false
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PageResponseAggregatedTxnInfoV1'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Unprocessable Entity
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '501':
          description: Not Implemented
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '502':
          description: Bad Gateway
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ErrorV1'
components:
  schemas:
    PageResponseAggregatedTxnInfoV1:
      type: object
      properties:
        page:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        total:
          type: integer
          format: int64
        items:
          type: array
          items:
            $ref: '#/components/schemas/AggregatedTxnInfoV1'
    MmaSettingsV1:
      type: object
      properties:
        id:
          type: string
          format: uuid
        hasAuthorizedMMA:
          type: boolean
        authorizedByClientIds:
          type: array
          items:
            type: string
            format: uuid
    ErrorV1:
      type: object
      properties:
        code:
          type: integer
          format: int32
          description: '### Error Codes


            | Code   | Description                         |

            |--------|-------------------------------------|

            | **0xx** | **Unknown or Unexpected**          |

            | 0    | Unknown error                         |

            | 40   | Unknown authentication error          |

            | **1xx** | **General**                        |

            | 101  | Invalid input                         |

            | 104  | Not found                             |

            | 140  | Access Denied                         |

            | 141  | Unauthorized                          |

            | 150  | Not implemented                       |

            | **10xx** | **Household**                     |

            | 1000 | Household not found                   |

            | 1001 | Duplicate contact                     |

            | 1002 | Household contact not found           |

            | 1003 | Household contact already exists      |

            | **11xx** | **Account**                       |

            | 1100 | Account not found                     |

            | 1110 | Invalid account group                 |

            | **12xx** | **User**                          |

            | 1200 | User not found                        |

            | 1201 | User profile not found                |

            | **13xx** | **Transfer**                      |

            | 1300 | Transfer not found                    |

            | 1301 | Transfer not supported                |

            | 1302 | Duplicate transfer                    |

            | 1303 | Funding account not found             |

            | 1304 | Duplicate funding account             |

            | **14xx** | **Client Agreement**              |

            | 1400 | Client Agreement not found            |

            | 1401 | Invalid Client Agreement file         |

            | 1402 | Client Agreement could not be updated |

            | **15xx** | **Trusted Contact**               |

            | 1500 | Trusted Contact not found             |

            | **17xx** | **Cash Set Aside**                |

            | 1700 | Cash set aside not found              |

            | 1701 | Cash set aside invalid amount         |

            | 1702 | Cash set aside invalid date           |

            | 1703 | Cash set aside upstream error         |

            | 1704 | Cash set aside cannot be cancelled    |

            | 1705 | Cash set aside invalid account        |

            | **18xx** | **Cash Settings**                 |

            | 1800 | Cash settings not found               |

            '
        message:
          type: string
        requestId:
          type: string
    AggregatedTxnInfoV1:
      type: object
      description: Aggregated transaction information for a single account
      properties:
        id:
          type: string
          format: uuid
          description: Financial account UUID (unique identifier)
        accountNumber:
          type: string
          description: Account number
        accountType:
          type: string
          description: Type/category of the account (e.g., IRA, ROTH_IRA)
        primaryBeneficiaryAge:
          type: integer
          format: int32
          description: Age of primary beneficiary
        distributionsYTD:
          type: number
          description: Total distributions year-to-date
        contributionsYTD:
          type: number
          description: Total contributions year-to-date
        aggregateSumOfPreviousTaxYearContributions:
          type: number
          description: Sum of contributions from previous tax year
        aggregateSumOfPreviousTaxYearDistributions:
          type: number
          description: Sum of distributions from previous tax year
        estimatedRemainingScheduledContributions:
          type: number
          description: Estimated remaining scheduled contributions
        estimatedRemainingScheduledDistributions:
          type: number
          description: Estimated remaining scheduled distributions
        yearlyMaximum:
          type: number
          description: Maximum contribution allowed for the year
        totalRmd:
          type: number
          description: Total required minimum distribution
        totalRmdPreviousYear:
          type: number
          description: Required minimum distribution from previous year
        isAutomatedRmd:
          type: boolean
          description: Whether RMD is automated
        autoRmdFrequency:
          type: string
          description: Frequency of automated RMD
          enum:
          - Weekly
          - Biweekly
          - Monthly
          - Quarterly
          - SemiAnnually
          - Annually
          - OneTime
          - Once
        requiresRmdCalculation:
          type: boolean
          description: Whether RMD calculation is required
      required:
      - id
    CashBalanceV1:
      type: object
      properties:
        id:
          type: string
          format: uuid
        balance:
          type: number
        availableForTrade:
          type: number
        availableForWithdrawal:
          type: number
        unsettledCash:
          type: number
        pendingDeposits:
          type: number
        pendingWithdrawals:
          type: number
        pendingBuyOrders:
          type: number
        pendingSellOrders:
          type: number
        currency:
          type: string
        asOfDate:
          type: string
          format: date
x-provenance:
  method: searched
  source: https://developer.altruist.com/reference
  harvested: '2026-10-13'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.altruist.com/reference/assignaccountportfolio-1.md
  - https://developer.altruist.com/reference/assignaccounttohousehold.md
  - https://developer.altruist.com/reference/associatedrafttobundle.md
  - https://developer.altruist.com/reference/batchdeletebeneficiaries.md
  - https://developer.altruist.com/reference/cancelacattransfer.md
  - https://developer.altruist.com/reference/cancelcashsetaside.md
  - https://developer.altruist.com/reference/cancelcashtransfer-1.md
  - https://developer.altruist.com/reference/cancelscheduledtransfer-1.md
  - https://developer.altruist.com/reference/checkdrafteligibility.md
  - https://developer.altruist.com/reference/createaccountgroup.md
  - https://developer.altruist.com/reference/createbanklink.md
  - https://developer.altruist.com/reference/createbeneficiary.md
  - https://developer.altruist.com/reference/createbundle.md
  - https://developer.altruist.com/reference/createcashsetaside.md
  - https://developer.altruist.com/reference/createcashtransfer-1.md
  - https://developer.altruist.com/reference/createdraftinbundle.md
  - https://developer.altruist.com/reference/createfundingaccount-1.md
  - https://developer.altruist.com/reference/createhousehold.md
  - https://developer.altruist.com/reference/createhouseholdcontact.md
  - https://developer.altruist.com/reference/createinvite.md
  - https://developer.altruist.com/reference/createlinktoken.md
  - https://developer.altruist.com/reference/createplaidfundingaccount.md
  - https://developer.altruist.com/reference/createscheduledtransfer-1.md
  - https://developer.altruist.com/reference/createtransfer-1.md
  - https://developer.altruist.com/reference/createuser.md
  - https://developer.altruist.com/reference/deleteaccountportfolio-1.md
  - https://developer.altruist.com/reference/deletebanklink.md
  - https://developer.altruist.com/reference/deletebeneficiary.md
  - https://developer.altruist.com/reference/deletebundle.md
  - https://developer.altruist.com/reference/deleteclientagreement-1.md
  - https://developer.altruist.com/reference/deletehousehold.md
  - https://developer.altruist.com/reference/deletetransfer-1.md
  - https://developer.altruist.com/reference/deletetrustedcontact-1.md
  - https://developer.altruist.com/reference/downloadclientagreementfile-1.md
  - https://developer.altruist.com/reference/getacattransfer.md
  - https://developer.altruist.com/reference/getaccount.md
  - https://developer.altruist.com/reference/getaccountcashsettings.md
  - https://developer.altruist.com/reference/getaccountgroup.md
  - https://developer.altruist.com/reference/getaccountgroups.md
  - https://developer.altruist.com/reference/getaccountportfolio-1.md
  - https://developer.altruist.com/reference/getaggregatedtransactions-1.md
  - https://developer.altruist.com/reference/getaggregatedtransactions_1.md
  - https://developer.altruist.com/reference/getallfundingaccounts-1.md
  - https://developer.altruist.com/reference/getallhouseholdsbyorgid.md
  - https://developer.altruist.com/reference/getalltransfers-1.md
  - https://developer.altruist.com/reference/getbanklink.md
  - https://developer.altruist.com/reference/getbeneficiary.md
  - https://developer.altruist.com/reference/getbundle.md
  - https://developer.altruist.com/reference/getcashsetaside.md
  - https://developer.altruist.com/reference/getcashsummary-1.md
  - https://developer.altruist.com/reference/getclientagreementdetails-1.md
  - https://developer.altruist.com/reference/getcontributionlimitforyear-1.md
  - https://developer.altruist.com/reference/getcontributionlimits-1.md
  - https://developer.altruist.com/reference/getfundingaccount-1.md
  - https://developer.altruist.com/reference/gethouseholdbyid.md
  - https://developer.altruist.com/reference/gethouseholdcontact.md
  - https://developer.altruist.com/reference/gethouseholdcontacts.md
  - https://developer.altruist.com/reference/getinvite.md
  - https://developer.altruist.com/reference/getinvitestatus.md
  - https://developer.altruist.com/reference/getmmasettings.md
  - https://developer.altruist.com/reference/getmodel-1.md
  - https://developer.altruist.com/reference/getpointsofcontact.md
  - https://developer.altruist.com/reference/getportfolio-1.md
  - https://developer.altruist.com/reference/getportfolios-1.md
  - https://developer.altruist.com/reference/getportfolios_1-1.md
  - https://developer.altruist.com/reference/getsecurities-1.md
  - https://developer.altruist.com/reference/gettimeweightedreturnsforresourcegroup-1.md
  - https://developer.altruist.com/reference/gettransferbyid-1.md
  - https://developer.altruist.com/reference/gettrustedcontact-1.md
  - https://developer.altruist.com/reference/getuserprofilebyuserid.md
  - https://developer.altruist.com/reference/getweightedmodelsforportfolio-1.md
  - https://developer.altruist.com/reference/initiateacattransfer.md
  - https://developer.altruist.com/reference/listacattransfers.md
  - https://developer.altruist.com/reference/listaccounts.md
  - https://developer.altruist.com/reference/listbanklinks.md
  - https://developer.altruist.com/reference/listbanklinksbyfundingaccount.md
  - https://developer.altruist.com/reference/listbeneficiaries.md
  - https://developer.altruist.com/reference/listbundles.md
  - https://developer.altruist.com/reference/listcashsetasides.md
  - https://developer.altruist.com/reference/listcashtransfers-1.md
  - https://developer.altruist.com/reference/listdraftsinbundle.md
  - https://developer.altruist.com/reference/listfundingeligibleaccounts.md
  - https://developer.altruist.com/reference/listhouseholdaccounts.md
  - https://developer.altruist.com/reference/listscheduledtransfers-1.md
  - https://developer.altruist.com/reference/removedraftfrombundle.md
  - https://developer.altruist.com/reference/resendacatconfirmation.md
  - https://developer.altruist.com/reference/setallocations.md
  - https://developer.altruist.com/reference/unassignaccount.md
  - https://developer.altruist.com/reference/updateaccount.md
  - https://developer.altruist.com/reference/updatebeneficiary.md
  - https://developer.altruist.com/reference/updateclientagreement-1.md
  - https://developer.altruist.com/reference/updatedraftinbundle.md
  - https://developer.altruist.com/reference/updatefundingaccount-1.md
  - https://developer.altruist.com/reference/updatehousehold.md
  - https://developer.altruist.com/reference/updatetransfer-1.md
  - https://developer.altruist.com/reference/updatetrustedcontact-1.md
  - https://developer.altruist.com/reference/updateuserprofile.md
  - https://developer.altruist.com/reference/validatecashsetaside.md
  merge:
    pages: 98
    deduped: 228
    conflicts_kept_first: 0