This period against the last
Money in, money out, net and closing balance, with the period before. The comparison window is the same length immediately before, not the previous calendar month. Comparing a partial month against a whole one shows a fall that is an artefact of the calendar, which is the classic way a dashboard invents bad news. Reported per currency and never summed. Adding 500 EUR to 500 USD gives 1000 of nothing; `/fx/display/balance` is the endpoint that converts, and it says when it could not price a leg.
Money in, money out, net and closing balance, with the period before.
The comparison window is the same length immediately before, not the previous calendar month. Comparing a partial month against a whole one shows a fall that is an artefact of the calendar, which is the classic way a dashboard invents bad news.
Reported per currency and never summed. Adding 500 EUR to 500 USD gives
1000 of nothing; /fx/display/balance is the endpoint that converts, and
it says when it could not price a leg.
Authorization
OAuth2PasswordBearer In: header
Query Parameters
day, week or month. The comparison window is the same length immediately before.
"month"Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/api/b/v1/metrics/kpis"{ "period": "string", "period_start": "2019-08-24T14:15:22Z", "period_end": "2019-08-24T14:15:22Z", "previous_start": "2019-08-24T14:15:22Z", "currencies": [ { "currency": "string", "money_in": { "current_minor": 0, "previous_minor": 0, "change_minor": 0, "change_bps": 0 }, "money_out": { "current_minor": 0, "previous_minor": 0, "change_minor": 0, "change_bps": 0 }, "net": { "current_minor": 0, "previous_minor": 0, "change_minor": 0, "change_bps": 0 }, "closing_balance": { "current_minor": 0, "previous_minor": 0, "change_minor": 0, "change_bps": 0 } } ]}How long the money lasts at the recent rate of burn GET
Available balance over the recent burn, per currency. **Net burn, not gross outgoings.** A business that collects as well as pays out is burning the difference. Dividing the balance by `money_out` would understate the runway of most businesses on this platform, and in the reassuring direction is the only direction this figure must not be wrong in. **Computed here rather than in the client**, which could otherwise do the arithmetic itself: a client reading a capped statement gets a truncated window, an understated burn, and an overstated runway. "Fourteen months" when it is four. Per currency and never summed — adding EUR to USD gives a number of nothing. `/fx/display/balance` is the endpoint that converts.
A closing balance per day GET
What this wallet held at the end of each day, oldest first. Each point is the `balance_after` of the last entry on or before that day, which is the ledger's own running total — so a sparkline drawn from this agrees with the statement rather than approximating it. A day with no movement repeats the previous close, because that is what the balance was. Days before the wallet held anything are omitted rather than reported as zero: a leading zero draws a rise out of an account that did not exist.