Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

User session token

Query Parameters

account_id
string | null

The trading account to read. Omit for the caller's default account.

limit
integer<int32> | null

Page size; defaults to DEFAULT_PAGE_SIZE.

Required range: x >= 0
offset
integer<int32> | null

Rows to skip; defaults to 0.

Required range: x >= 0
symbol
string | null

Restrict to one instrument symbol.

payout_status
null | enum<string>

Restrict to rewards at one point in the payout lifecycle. Where a reward stands on its way to being paid.

  • accrued — earned on the most recently closed epoch, not yet put up for approval.
  • awaiting — submitted for approval.
  • approved — cleared for payment.
  • paid — credited to the account.
  • retained — forfeited and kept by the exchange, because the reward fell below the minimum payout. Not a stage on the way to paid.
Available options:
accrued,
awaiting,
approved,
paid,
retained
start_date
string<date> | null

Inclusive YYYY-MM-DD lower bound on the epoch day.

end_date
string<date> | null

Inclusive YYYY-MM-DD upper bound on the epoch day.

Response

200 - application/json

The caller's reward accruals, with totals and a per-day trend

total_count is the filtered set's size, which accruals pages over.

limit
integer<int32>
required
Required range: x >= 0
offset
integer<int32>
required
Required range: x >= 0
total_count
integer<int64>
required
Required range: x >= 0
accruals
object[]
required

One page of the filtered set, newest epoch first.

summary
object
required

Totals over the whole filtered set, not just the page.

symbols
string[]
required

Every symbol you have ever accrued on, over the whole ledger — so a caller can tell which instruments engaged the program without reading every page.

trend
object[]
required

Per-day totals over the whole filtered set, not just the page.

window
object
required

Inclusive epoch-day bounds of the whole ledger, for date inputs.