API referenceMetrics

How long the money lasts at the recent rate of burn

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.

GET
/api/b/v1/metrics/runway

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.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

basis_days?Basis Days

Trailing window to average the burn over. Seven is the shortest that is not one bad week, and a year is the longest that still describes how the business runs now.

Range7 <= value <= 365
Default90
currency?|null
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/metrics/runway"
{  "basis_days": 90,  "currencies": [    {      "currency": "string",      "months": 6.4,      "burn_minor": 3800000,      "available_minor": 24320000,      "reason": "not_burning"    }  ]}