API reference

Holdings

get/v1/holdings

List holdings

holdings.listread tokenidempotent

Every holding row: how many shares of which security each investment account holds, what the institution says it is worth and what it cost. Amounts are in the holding's own currency.

Parameters

limit integer · query	Page size, 1–200.
cursor string \| null · query	The `next_cursor` of the previous page.
account_id integer \| null · query	Only this account's holdings. Ids from `accounts.list`.
X-Organization-Id string \| null · header

Returns 200 · HoldingList

data array of Holding · required
has_more boolean · required
next_cursor string \| null · required

Example

curl -X GET "https://api.lumaledger.app/v1/holdings" \
  -H "Authorization: Bearer $LUMALEDGER_TOKEN"

Objects

Holding

A security held in one account.

Fields

account_id integer · required	The investment account holding it.
cost_basis Money \| null · required
gain_percent string \| null · required	Unrealized gain since purchase, in percent; null without both a market value and a cost basis. Pattern: `^-?\d+(\.\d+)?$`.
id integer · required
is_estimate boolean · required	True when `value` is the cost basis.
market_value Money \| null · required	The institution's value; null for manual rows.
name string · required
price UnitPrice \| null · required	The institution's last price per share.
price_as_of date \| null · required	When the institution priced it.
quantity string · required	Shares or units held. Pattern: `^-?\d+(\.\d+)?$`.
source string · required	`plaid`, `manual` or `seed`.
symbol string · required	The ticker; `positions.get` takes it.
updated_at datetime · required
value Money · required	`market_value`, or `cost_basis` standing in when there is none — for the owned (vested) units only, so unvested award units never count.
vested_quantity string \| null · required	For an equity award (a stock-plan account): the units that have vested and are the holder's. Null when the institution reports no vesting split, meaning every unit is owned. Pattern: `^-?\d+(\.\d+)?$`.

HoldingList

A page of holdings, in id order.

Fields

data array of Holding · required
has_more boolean · required
next_cursor string \| null · required

Money

An amount and its currency. `amount` is a base-10 string with two decimal places and an optional leading minus sign. Parse it with a decimal type, not a float.

Fields

amount string · required	Pattern: `^-?\d+\.\d{2}$`.
currency string · required	ISO 4217 code. Pattern: `^[A-Z]{3}$`.

UnitPrice

A price per share or per unit. Unlike `Money` it keeps the precision the institution quoted (up to 8 places): a coin or a penny stock is not priced in whole cents.

Fields

amount string · required	Pattern: `^-?\d+(\.\d+)?$`.
currency string · required	ISO 4217 code. Pattern: `^[A-Z]{3}$`.