API

List investments

List investment holdings (manual or bank).

Manual holdings by optional groupId. Bank: source=bank and groupId = connectionId.

GET/v1/list_investments

Query

FieldTypeRequiredDefaultDescription
budgetIdstringYes—Budget whose holdings to list.
groupIdstringConditional—Manual group filter, or required connectionId when source is bank.
sourcestringNomanualmanual (default) or bank.

Response data

FieldTypeDescription
itemsarrayArray of investment holdings in this result.

Item fields

FieldTypeDescription
idstringId of the investment holding.
sourcestringmanual or bank.
groupIdstringParent manual group id, or bank connectionId when bank-scoped.
connectionIdstringPresent on bank holdings (same as groupId for bank lists).
namestringHuman-readable name shown in the app.
balancenumberCurrent balance or marked market value of the holding.
currencystringISO 4217 currency code.
typestringHolding type when set (manual).
subtypestringHolding subtype when set (manual).
codestringTicker / code when set (manual).
isinstringISIN when set (manual).
quantitynumberShare/unit quantity when set (manual).
unitValuenumberPer-unit value when set (manual).
budgetIdstringOwning budget id when present on manual holdings.
isDeletedbooleanSoft-delete flag when present.
updatedAtstringLast update timestamp when present.