Skip to main content
GET
Get realized return per trading day

Authorizations

Authorization
string
header
required

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

Query Parameters

account_id
string<uuid>

Trading account ID. Omit to report every account the organization has in environment

environment
enum<string>
required

Required. Which environment the read covers. Resolved to the organization's accounts in that environment, including disabled and deleted ones, since the ledger stores no environment of its own. Rejected with 400 when it disagrees with the account named alongside it.

Available options:
paper,
live
start
string<date-time>

Range start, raised to the window the caller's plan grants and then widened back to the Sunday of the week containing it, so the oldest week reported can begin inside that window. Defaults to the start of the week end falls in

end
string<date-time>

Range end, widened forward to the Saturday of the week containing it. Defaults to now, so sending neither bound returns the current week

next_cursor
string

Start of the next page as YYYY-MM-DD, taken from a previous response. Overrides start

Response

Daily returns retrieved

data
object[]
required

Whole weeks, oldest first.

next_cursor
string | null

The Sunday the next page starts at, as YYYY-MM-DD, or null once the requested range is exhausted. Pass it back as next_cursor.

Unlike the keyset cursors on the list endpoints this is a plain date: it is a week boundary the caller can already work out, so there is nothing to be gained by making it opaque.