List validator reward coupons

Returns the reward coupons issued to a validator, newest first. Canton pays validators
by issuing a coupon per reward round; the validator then claims it, converting it to
Canton Coin. This endpoint reports the coupons, which is the earnings record.

Filter status=claimable for rewards still available to claim — the practical use is
noticing that claims have stopped running.

Three limits to understand before relying on this.

status: settled does not distinguish a claim from a lapse. The ledger offers separate
choices for the validator claiming a coupon and for the network expiring an unclaimed
one, and both simply archive the record. A settled coupon may therefore represent
revenue collected or revenue lost, and this endpoint cannot tell you which.

Reward rounds themselves are not exposed. The round number is reported as issued, but
round timing and issuance rates are held in records this API does not serve, so a
round number cannot be turned into a date or a rate here.

Coupon amounts are fixed, but Canton Coin balances are not — a Canton Coin holding
carries a per-round decay rate and loses value as rounds pass. Do not sum coupon
amounts and treat the result as a current balance; it is cumulative gross issuance,
not holdings.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🔑

This endpoint is served under the native tier. A request is refused with 403 if the native tier is not licensed for your account.

Query Params
string
length ≤ 255
^[A-Za-z0-9_-]+::[0-9a-f]{16,}$

Return only rewards issued to this validator. Matched exactly.

string
enum

Return only rewards of this kind.

Allowed:
string
enum

Return only rewards in this state. Use claimable for the outstanding set.

Allowed:
string
^[0-9]+$

Return only rewards issued for this reward round.

date-time

Return rewards issued at or after this instant.

date-time

Return rewards issued at or before this instant.

string
^[a-zA-Z]+:(asc|desc)$
Defaults to createdAt:desc

Ordering as field:direction. Timestamps default to desc.

integer
1 to 100
Defaults to 20

Maximum number of records to return in this page.

string
length ≤ 2048

Opaque cursor from a previous response's pagination.nextPageToken. Omit for the first page.

Headers
string
length ≤ 128

Optional client-supplied correlation identifier, echoed back in the X-Request-Id response header and requestId body field.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json