Altruist Accounts API
The accounts API from Altruist — 2 operation(s) for accounts.
The accounts API from Altruist — 2 operation(s) for accounts.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/altruist:altruist-accounts-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 0.0.2
title: Altruist Open Accounts API
description: A RESTFul API for accessing information from the Altruist Platform. Intended for partners that integrate with the Altruist Platform to access information that is maintained on the platform
license:
name: MIT
servers:
- url: https://openapi.altruist.com/altruist-open-api/
security:
- Authorization:
- households:read
- accounts:read
- positions:read
- cost_basis:read
- transactions:read
tags:
- name: Accounts
paths:
/api/v1/accounts/{household_id}:
get:
summary: Get a list of accounts for a given household/household
description: Get accounts for a given household/household. Returns a list of account ID-s associated with a given household/household.
operationId: listAccounts
tags:
- Accounts
parameters:
- name: household_id
in: path
description: ID of the household
required: true
schema:
type: string
example: f2e7d7530b68dee392284b2ce9c49075d63478502ea4c9de74c41ce6b8d2c5f0
- name: page
in: query
description: desired page number, defaults to 0
required: false
schema:
type: integer
format: int32
example: 1
- name: page_size
in: query
description: desired number of entries per page, defaults to 100, max value is 1000
required: false
schema:
type: integer
format: int32
example: 25
- name: X-API-Request-ID
in: header
description: household-provided request id
required: false
schema:
type: string
example: 2f047e95
responses:
'200':
description: A successful response for /accounts request
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/Pagination'
description: paging information for response
data:
$ref: '#/components/schemas/Accounts'
description: a list of account ID-s
examples:
first:
value:
paging:
page: 1
page_size: 25
total_pages: 3
data:
household_id: f2e7d7530b68dee392284b2ce9c49075d63478502ea4c9de74c41ce6b8d2c5f0
accounts:
- id: c87d1cd9511f5ab47d2eb9b55afb0bf6a23346e6af9b8b7e709a19389b93e989
rep_code: 3AAABC
account_type: INDIVIDUAL
account_name: Self-directed IRA
status: ACTIVE
date_open: 2019/01/15
date_closed: null
as_of_date: 2022/08/15
account_balance: 603698
- id: c87d1cd9511f5ab47d2eb9b55afb0bf6a23346e6af9b8b7e709a19389b93e989
rep_code: 3AAABC
account_type: INDIVIDUAL
account_name: Roth IRA
status: ACTIVE
date_open: 2018/05/03
date_closed: null
as_of_date: 2022/08/15
account_balance: 12478.36
'400':
description: Bad request error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: bad_request
message: invalid or missing user id
'401':
description: Unauthorized error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: unauthorized
message: user is not authorized
'403':
description: Forbidden error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: forbidden
message: User is forbidden to access this resource
'404':
description: Not found error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: resource_not_found
message: Household not found
'500':
description: Internal error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: internal_error
message: unable to connect to the data source
security:
- Authorization:
- accounts:read
/v2/accounts:
get:
summary: Get a list of accounts for a given household/household
description: Get accounts for a given household/household. Returns a list of account ID-s associated with a given household/household.
operationId: listAccountsV2
tags:
- Accounts
parameters:
- name: household_id
in: query
description: ID of the household
required: true
schema:
type: string
example: f2e7d7530b68dee392284b2ce9c49075d63478502ea4c9de74c41ce6b8d2c5f0
- name: page
in: query
description: desired page number, defaults to 0
required: false
schema:
type: integer
format: int32
example: 1
- name: page_size
in: query
description: desired number of entries per page, defaults to 100, max value is 1000
required: false
schema:
type: integer
format: int32
example: 25
responses:
'200':
description: A successful response for /accounts request
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/Pagination'
description: paging information for response
data:
$ref: '#/components/schemas/Accounts'
description: a list of account ID-s
examples:
first:
value:
paging:
page: 1
page_size: 25
total_pages: 3
data:
household_id: f2e7d7530b68dee392284b2ce9c49075d63478502ea4c9de74c41ce6b8d2c5f0
accounts:
- id: c87d1cd9511f5ab47d2eb9b55afb0bf6a23346e6af9b8b7e709a19389b93e989
rep_code: 3AAABC
account_type: INDIVIDUAL
account_name: Self-directed IRA
status: ACTIVE
date_open: 2019/01/15
date_closed: null
as_of_date: 2022/08/15
account_balance: 603698
- id: c87d1cd9511f5ab47d2eb9b55afb0bf6a23346e6af9b8b7e709a19389b93e989
rep_code: 3AAABC
account_type: INDIVIDUAL
account_name: Roth IRA
status: ACTIVE
date_open: 2018/05/03
date_closed: null
as_of_date: 2022/08/15
account_balance: 12478.36
'400':
description: Bad request error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: bad_request
message: invalid or missing user id
'401':
description: Unauthorized error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: unauthorized
message: user is not authorized
'403':
description: Forbidden error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: forbidden
message: User is forbidden to access this resource
'404':
description: Not found error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: resource_not_found
message: Household not found
'500':
description: Internal error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
first:
value:
error_type: internal_error
message: unable to connect to the data source
security:
- Authorization:
- accounts:read
components:
schemas:
Error:
type: object
required:
- error_type
- message
properties:
error_type:
type: string
description: Describes the type or source of error
enum:
- internal_error
- bad_request
- dependency_unavailable
- resource_not_found
- resource_already_exists
- unauthorized
example: unauthorized
message:
type: string
description: Error message corresponding to the error code
example: User is not authorized
Pagination:
type: object
description: Description of a paginated response
properties:
page:
type: integer
format: int32
description: Desired page number, default is 0
default: 0
example: 1
page_size:
type: integer
format: int32
description: Page size, default is 100 items
default: 100
example: 25
total_pages:
type: integer
format: int32
description: Total number of pages
default: 1
example: 3
required:
- page
- page_size
- total_pages
Account:
type: object
description: A description of an investment Account
required:
- id
- rep_code
- account_number
- account_type
- account_name
- as_of_date
- account_balance
properties:
id:
type: string
example: 114233218302b48cdc8164ea4bb55adb730437535e0853e9c9801d366c61214f
description: the id has length of 64 lower-case alphanumeric chars
rep_code:
type: string
example: 3AAABC
account_number:
type: string
example: 3AA08867
account_type:
type: string
example: INDIVIDUAL
account_name:
type: string
example: Self-directed IRA
status:
type: string
example: ACTIVE
date_open:
type: string
example: 2020/09/18
date_closed:
type: string
example: 2020/11/25
as_of_date:
type: string
example: 2021/03/11
account_balance:
type: number
example: 5607.65
Accounts:
type: object
description: A description of Accounts associated with a given Household/Household
properties:
household_id:
type: string
description: An ID of the Household/Household
example: f2e7d7530b68dee392284b2ce9c49075d63478502ea4c9de74c41ce6b8d2c5f0
accounts:
type: array
description: A list of Accounts
items:
$ref: '#/components/schemas/Account'
securitySchemes:
Authorization:
type: http
scheme: bearer
description: Access Token
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/accountsv1.md
- https://developer.altruist.com/reference/accountsv2.md
- https://developer.altruist.com/reference/costbasisv1.md
- https://developer.altruist.com/reference/costbasisv2.md
- https://developer.altruist.com/reference/disabledatafeedbyid.md
- https://developer.altruist.com/reference/enabledatafeed.md
- https://developer.altruist.com/reference/getdatafeedbyid.md
- https://developer.altruist.com/reference/getdatafeeds.md
- https://developer.altruist.com/reference/householdsv1.md
- https://developer.altruist.com/reference/householdsv2.md
- https://developer.altruist.com/reference/positionsv1.md
- https://developer.altruist.com/reference/positionsv2.md
- https://developer.altruist.com/reference/requesthistoricaldatafile.md
- https://developer.altruist.com/reference/transactionsv2.md
merge:
pages: 14
deduped: 45
conflicts_kept_first: 0