Skip to main content
GET
Get affiliate commission history
The response body shown here is a static example, not live data. After you click Send, your live result appears in a separate panel headed 200 OK. The panel under the status-code tabs is a fixed sample from the spec — its field values (fees, prices, sizes, IDs, timestamps) are placeholders. Use Send, or call the endpoint, for current values.
Returns one page of an affiliate’s per-fill commission events, ordered by fillId DESC, tier ASC, referee ASC. Each row carries both the per-event delta (amountQuantums) and the post-event snapshot (postTotalCommissionQuantums, postPendingCommissionQuantums) stamped by the referral service at emission time, so clients never have to re-aggregate.

Query Parameters

address
string
required

Affiliate address to fetch the commission log for. 20-byte EVM address as hex: optional 0x or 0X prefix and exactly 40 hexadecimal digits. API responses normalize to lowercase af after 0x.

Pattern: ^(0x|0X)?[0-9a-fA-F]{40}$
from
integer<int64>

Optional inclusive lower bound on timestamp_ms. Omit for no lower bound (start of time).

Required range: x >= 0
to
integer<int64>

Optional inclusive upper bound on timestamp_ms. Omit for no upper bound (current time).

Required range: x >= 0
limit
integer
default:1000

Maximum rows to return. Default and maximum are both 1000; requests above the maximum are silently clamped.

Required range: 1 <= x <= 1000
cursor
string

Optional opaque cursor returned as nextCursor by the previous response. Cursors are scoped to the same address and optional from/to bounds.

Response

Commission events newest-first.

commissions
object[]
required
nextCursor
string

Opaque cursor for the next page, encoded from the last returned row's (fillId, tier, referee). Omitted when there is no next page.