v6

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0161197504.7 KB

performance

Retrieve Position Returns (MWRR / TWRR)

Retrieve the position's MWRR and TWRR for the requested period.

get/positions/{position_id}/returns

position_idstring required

period'1d' | '1w' | '1m' | 'this-month' | '3m' | '6m' | 'ytd' | '1y' | 'all' required

Predefined period over which returns are computed.

flagsReturnsFlag[] required

Signals explaining clamps, missing data, or uncomputable rates.

mwrrstring nullable required

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

period'1d' | '1w' | '1m' | 'this-month' | '3m' | '6m' | 'ytd' | '1y' | 'all' required

period_endstring date-time required

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

period_startstring date-time required

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

positionstring required

ID of the position the returns were computed for.

twrrstring nullable required

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

{
  "mwrr": "0.0925",
  "period_end": "2026-07-14T09:34:12Z",
  "period_start": "2026-01-01T00:00:00Z",
  "twrr": "0.0875"
}