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 the caller’s own 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. Signed, and scoped to the caller. address must be the API key’s master Ethereum address; reading another affiliate’s commission log is 403. The Ed25519 request signature is required because X-API-Key alone proves nothing (API keys are Ed25519 public keys, listable by anyone via GET /v1/apiKeys). With no request body the signing message is timestamp + action (action commissions — the path segment verbatim, casing included).

Authorizations

X-API-Key
string
header
required

Hex-encoded Ed25519 public key (64 chars). The public key IS the API key — register it via POST /createApiKey. Required on every authenticated request, both read-only and signed.

X-Timestamp
string
header
required

Unix time in nanoseconds as a decimal string (e.g. "1713825891591000000"). Millisecond or second epochs are rejected with 401 Unauthorized. Must be within ±30,000 ms of server wall-clock, or the request is rejected with 401 Unauthorized. Required on all mutating / credential-creating endpoints. This same value must appear as the ct field in the ordersign typed canonical payload (single-order endpoints) or in each element's ct field (batch endpoints).

X-Signature
string
header
required

Lowercase hex-encoded Ed25519 signature (128 chars).

Single-order endpoints (placeOrder, cancelOrder, modifyOrder, and other non-batch mutating routes) sign over the ordersign typed canonical payload — a compact, key-sorted JSON object built from parsed request fields using engine-native integer values:

ct must equal the X-Timestamp header value. Keys in brackets are conditional (omitted when empty). op values: 1=place, 2=cancel, 3=modify. See the ordersign package for field definitions and reference signing code.

Other signed routes (e.g. createApiKey) still use the legacy scheme: signing_message = X-Timestamp + ACTION + canonicalJSON(body), where ACTION is the camelCase final path segment.

Batch endpoints (batchPlaceOrders, batchCancelOrders, batchModifyOrders) do NOT use this header. They authenticate with per-element typed ordersign signatures embedded in the request body (see the global auth description and the per-field signature descriptions on OrderRequest / CancelOrderRequest / ModifyOrderRequest).

Read endpoints are authenticated by ?address= (and optionally X-API-Key) only — no signature is required, except for the signed affiliate reads (see the Referral tag), which require the full header triple; with no body their signing message is X-Timestamp + ACTION. canonicalJSON(body) is the JSON body with object keys sorted lexicographically at every level and no whitespace; the server canonicalizes the received body before verifying, so only the bytes signed over must be canonical. Required on all mutating / credential-creating endpoints.

Query Parameters

address
string
required

Affiliate address to fetch the commission log for. Must match the API key's master address.

20-byte EVM address as hex: optional 0x or 0X prefix and exactly 40 hexadecimal digits. API responses normalize to lowercase a–f 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.