JOjoinsophic
performance

Retrieve Account Returns (MWRR / TWRR)

Changed on

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

get/accounts/{account_id}/returns

Request

  • Base URL
    https://api.engine.usesophic.com
  • Auth
    HTTP bearer

Path parameters

account_idstring required

Query parameters

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

Predefined period over which returns are computed.

Response

Successful Response

accountstring required

ID of the account the returns were computed for.

flagsReturnsFlag[] required

Signals explaining clamps, missing data, or uncomputable rates.

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.

Example response

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

Changes

  • 6a63920239d8Revision changes
    • breaking

      the query request parameter period was restricted to a list of enum values

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new 1d enum value to the response property for the response status

    • warning

      added the new 1m enum value to the response property for the response status

    • warning

      added the new 1w enum value to the response property for the response status

    • warning

      added the new 1y enum value to the response property for the response status

    • warning

      added the new 3m enum value to the response property for the response status

    • warning

      added the new 6m enum value to the response property for the response status

    • warning

      added the new all enum value to the response property for the response status

    • warning

      added the new this-month enum value to the response property for the response status

    • warning

      added the new ytd enum value to the response property for the response status

    • info

      added the new enum value 1d to the query request parameter period

    • info

      added the new enum value 1m to the query request parameter period

    • info

      added the new enum value 1w to the query request parameter period

    • info

      added the new enum value 1y to the query request parameter period

    • info

      added the new enum value 3m to the query request parameter period

    • info

      added the new enum value 6m to the query request parameter period

    • info

      added the new enum value all to the query request parameter period

    • info

      added the new enum value this-month to the query request parameter period

    • info

      added the new enum value ytd to the query request parameter period

    • info

      for the query request parameter period, the type was generalized from no type to string

    • info

      removed from the response property allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property anyOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • b4b87fc2006cRevision changes
    • info

      added the required property to the response with the status