API reference

Net Worth

get/v1/net-worth

Get net worth

net_worth.getread tokenidempotent

The ledger's net worth today, its assets and liabilities, and how it moved over the past 30 days, in the ledger's base currency.

Parameters

X-Organization-Id

string | null · header

Returns 200 · NetWorth

as_of date · required
assets Money · required	Everything the ledger owns, in its base currency.
change_30d Money · required	How much net worth moved over the past 30 days.
change_30d_percent string · required	`change_30d` as a percentage of net worth 30 days ago (`"4.25"` is 4.25%). `"0"` when there is nothing to compare with. Pattern: `^-?\d+(\.\d+)?$`.
liabilities Money · required	Everything it owes, positive.
net_worth Money · required	`assets` − `liabilities`.

Example

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

get/v1/net-worth/breakdown

Net worth breakdown

net_worth.breakdownread tokenidempotent

What the assets and liabilities are made of today: classes (cash, investments, retirement, real estate, credit cards, loans, …) and the accounts in each, with every account's balance in the base currency and its own.

Parameters

X-Organization-Id

string | null · header

Returns 200 · NetWorthBreakdown

as_of date · required
assets BreakdownSide · required
currency string · required	The ledger's base currency.
liabilities BreakdownSide · required

Example

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

get/v1/net-worth/cash-real-value

Real value of cash after inflation

net_worth.cash_real_valueread tokenidempotent

What holding each checking and savings account was really worth over the window: the interest it earned against the consumer price index of its currency. The index line strips out deposits and withdrawals, so two accounts are comparable; purchasing_power_change is the money actually held against the inflation it sat through.

Parameters

range string · query	The window: `3M`, `6M`, `1Y` or `ALL`.
X-Organization-Id string \| null · header

Returns 200 · CashRealValue

accounts array of CashRealValueAccount · required
range string · required

Example

curl -X GET "https://api.lumaledger.app/v1/net-worth/cash-real-value" \
  -H "Authorization: Bearer $LUMALEDGER_TOKEN"

get/v1/net-worth/history

Net worth over time

net_worth.historyread tokenidempotent

Net worth, assets and liabilities at the end of every day that moved them between since and until. The first point sits on since and carries in the balance from before it, so a chart starts at the right height. Narrow the series to some accounts with account_id or role (the investments or one loan's page do).

Parameters

since date \| null · query	First day of the window. Defaults to a year ago.
until date \| null · query	Last day of the window. Defaults to today.
account_id array of integer \| null · query	Only these accounts (repeat the parameter). Ids from `accounts.list`.
role array of string \| null · query	Only accounts with these roles (`brokerage`, `ira`, `mortgage`, …).
X-Organization-Id string \| null · header

Returns 200 · NetWorthHistory

currency string · required	The ledger's base currency; every amount is in it.
points array of NetWorthPoint · required	Oldest first.

Example

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

Objects

BreakdownAccount

Fields

account_id integer · required
balance Money · required	In the ledger's base currency, positive on the account's normal side.
linked_asset LinkedAsset \| null · required	For a mortgage or auto loan: the property or vehicle it finances.
mask string \| null · required
name string · required
native_balance Money · required	In the account's own currency.
role string \| null · required
share string · required	Share of its side (assets or liabilities), 0–1. Pattern: `^-?\d+(\.\d+)?$`.

BreakdownGroup

Fields

accounts array of BreakdownAccount · required	Largest first.
key string · required	The class: `cash`, `investments`, `retirement`, `tax_advantaged`, `alternatives`, `real_estate`, `vehicles`, `other_assets`; or `credit_cards`, `loans`, `other_liabilities`.
share string · required	Share of its side, 0–1. Pattern: `^-?\d+(\.\d+)?$`.
total Money · required

BreakdownSide

Fields

groups array of BreakdownGroup · required	Largest first.
total Money · required

CashRealValue

What holding each cash account was really worth over the window: interest earned against inflation, with deposits and withdrawals stripped out. An account whose currency has no published index is left out rather than guessed at.

Fields

accounts array of CashRealValueAccount · required
range string · required

CashRealValueAccount

Fields

account_id integer · required
currency string · required
end date · required
index array of string · required	A time-weighted real-return index based at 100 on `start`, thinned to at most 60 evenly spaced points ending at `end`. Below 100 means inflation outran the interest the money earned.
index_code string · required	The consumer price index it is measured against.
inflation_percent string · required	Pattern: `^-?\d+(\.\d+)?$`.
interest_earned Money · required
provisional boolean · required	The tail is held flat: no published index covers it yet.
purchasing_power_change Money · required	What the money actually held gained or lost in purchasing power.
real_return_percent string · required	Pattern: `^-?\d+(\.\d+)?$`.
start date · required

LinkedAsset

Fields

kind string · required	`property` or `vehicle`: what this loan finances.
label string · 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}$`.

NetWorth

The ledger's net worth today.

Fields

as_of date · required
assets Money · required	Everything the ledger owns, in its base currency.
change_30d Money · required	How much net worth moved over the past 30 days.
change_30d_percent string · required	`change_30d` as a percentage of net worth 30 days ago (`"4.25"` is 4.25%). `"0"` when there is nothing to compare with. Pattern: `^-?\d+(\.\d+)?$`.
liabilities Money · required	Everything it owes, positive.
net_worth Money · required	`assets` − `liabilities`.

NetWorthBreakdown

What the assets and liabilities are made of, by class and account. It adds up to net_worth.get.

Fields

as_of date · required
assets BreakdownSide · required
currency string · required	The ledger's base currency.
liabilities BreakdownSide · required

NetWorthHistory

Net worth over time: one point per day that moved it, plus a point at since carrying the balance in from before the window.

Fields

currency string · required	The ledger's base currency; every amount is in it.
points array of NetWorthPoint · required	Oldest first.

NetWorthPoint

Fields

assets Money · required
date date · required
liabilities Money · required	Positive: what is owed.
value Money · required	Net worth at the end of the day.