Skip to main content
GET
Get affiliate info
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 affiliate information including code, tier, commission totals, and referee count.

Query Parameters

address
string
required

Ethereum address of the affiliate. 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}$

Response

Affiliate info.

address
string

Lower-case 0x-prefixed 20-byte affiliate address.

code
string

Active referral code, or empty string if revoked / never created.

kickbackBps
integer

Affiliate's current kickback rate in basis points (0-5000). 0 means no kickback.

tier
integer

Current affiliate/account tier level used for referral commission rates. Use tradingFeeTier for the corresponding maker/taker fee BPS details.

totalCommission
integer<int64>

Lifetime commission earned, in quote quantums (1e9 = $1). Snapshot from affiliate_state.total_commission_quantums, which is the most recent post-event total stamped by the referral service.

pendingCommission
integer<int64>

Commission earned since the last claim cutoff, in quote quantums. Decreases to 0 when a ClaimProcessed event covers the full outstanding balance.

rollingVolume
integer<int64>

Notional fill volume over the trailing 30 days, in quote quantums. null/0 if the rollup is temporarily unavailable; the endpoint degrades gracefully rather than failing /info.

totalReferredVolume30d
integer<int64>

Combined trailing-30-day notional fill volume of all of this affiliate's direct (T1) referees, in quote quantums (1e9 = $1). Read from the hourly volume rollup. 0 if the rollup is temporarily unavailable; the endpoint degrades gracefully.

commission30d
integer<int64>

Commission earned over the trailing 30 days, in quote quantums. Computed as the lifetime commission snapshot minus the running commission total as of the window start (boundary subtraction). 0 if the rollup is temporarily unavailable; the endpoint degrades gracefully.

tradingFeeTier
object

The user's current trading fee tier (level + maker/taker BPS). Omitted when the store has not yet recorded a tier for this address (new accounts before the first AccountFeeTierUpdate).