Skip to main content
GET
Retrieve Account Returns (MWRR / TWRR)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id
string
required

Query Parameters

period
enum<string>
required

Predefined period over which returns are computed.

Available options:
1d,
1w,
1m,
this-month,
3m,
6m,
ytd,
1y,
all

Response

OK

account
string
required

ID of the account the returns were computed for.

flags
enum<string>[]
required

Signals explaining clamps, missing data, or uncomputable rates.

Available options:
inception_after_period_start,
missing_history,
twrr_uncomputable,
mwrr_uncomputable,
xirr_no_sign_change,
xirr_single_cashflow
mwrr
string | null
required

Cumulative money-weighted rate of return as a decimal; null when uncomputable.

Example:

"0.0925"

period
enum<string>
required

Requested period the returns were computed over.

Available options:
1d,
1w,
1m,
this-month,
3m,
6m,
ytd,
1y,
all
period_end
string<date-time>
required

Resolved end of the period (the asof time of the computation).

Example:

"2026-07-14T09:34:12Z"

period_start
string<date-time>
required

Resolved start of the period, inclusive. Clamped to the scope's inception when the requested period starts earlier.

Example:

"2026-01-01T00:00:00Z"

twrr
string | null
required

Cumulative time-weighted rate of return as a decimal; null when uncomputable.

Example:

"0.0875"