Accounts

GET /v2/accounts/

This endpoint allows users to retrieve a list of accounts associated with a given household. It returns a list of account ID-s associated with a given household/household.

Accounts Headers

Authorization required	The access token.

Accounts Parameters

household_id string, required	ID of the household.
page integer	Desired page number, default is 0.
page_size integer	Desired number of entries per page, defaults is 100, max value is 1000.

Accounts Response Object Fields

id string, required	The ID of the account.
rep_code string, required	Advisor Identifier.
account_type string, required	The type of the account. Possible values SOLO 401K TRADITIONAL BENEFICIARY IRA INDIVIDUAL ROTH BENEFICIARY IRA TRUST UTMA SEP IRA SIMPLE IRA C CORPORATION ROTH IRA IRA JOINT TENANTS WROS ROLLOVER IRA UGMA S CORPORATION
account_name string, required	The name of the account.
status string	Status of the account. Possible values ACTIVE REJECTED CLOSED RESTRICTED PENDING
date_open string	Account opening date.
date_closed string	Account closing date.
as_of_date string, required	Date of the record.
account_balance number, required	The current account balance.

GET /api/v1/accounts/{household_id} (deprecating soon)

This endpoint returns a list of account IDs associated with a given households/household IDs.

Accounts Headers

Authorization required	The access token.
X-API-Request-ID string	The household-provided request ID.

Accounts Parameters

household_id string, required	ID of the household.
page integer	Desired page number, default is 0.
page_size integer	Desired number of entries per page, defaults is 100, max value is 1000.

Accounts Response Object Fields

id string, required	The ID of the account.
rep_code string, required	Advisor identifier.
account_number string, required	Account number.
account_type string, required	The type of the account. Possible values SOLO 401K TRADITIONAL BENEFICIARY IRA INDIVIDUAL ROTH BENEFICIARY IRA TRUST UTMA SEP IRA SIMPLE IRA C CORPORATION ROTH IRA IRA JOINT TENANTS WROS ROLLOVER IRA UGMA S CORPORATION
account_name string, required	The name of the account.
status string	Status of the account. Possible values ACTIVE REJECTED CLOSED RESTRICTED PENDING
date_open string	Account opening date.
date_closed string	Account closing date.
as_of_date string, required	Date of the record.
account_balance number, required	The current account balance.

From there the endpoints GET altruist-open-api/account positions and GET altruist-open-api/account cost basis can be used to get positions and cost bases data by replacing the value [ACCOUNT_ID] in the endpoint URL by the account number.