Returns

List account returns

Returns the account's daily time-weighted return (TWR), which measures investment performance independently of deposits, withdrawals, and other external cash flows.

Use the offset and limit query parameters to page through results; meta.total_count gives the total number of matching returns.

See the Time-weighted returns guide (TOL / BYOL) for the calculation method.

get/accounts/{account_id}/returns

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/accounts/{account_id}/returns
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: account_returns:read)

Query parameters

start_datestring

Returns account returns starting from and including this date (UTC).

end_datestring

Returns account returns up until this date (UTC).

sort'date'

Sort the result by date.

order'ASC' | 'DESC'

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

limitinteger

Use the limit argument to specify the maximum number of items returned.

Response

OK

Changes

No recorded changes to this operation across all 25 revisions of this API.