Skip to main content
GET
Get an affiliate's accrued commission

Authorizations

Authorization
string
header
required

Bearer token from Geomi. See Authentication for setup instructions.

Query Parameters

affiliate_account
string
required

The affiliate's wallet address (not a subaccount address)

days
integer<int64>

Trailing UTC days of daily breakdown to return. Defaults to 30, clamped to 180.

Required range: x >= 0

Response

The affiliate's accrued commission

An affiliate's accrued commission: today, the running week, and lifetime.

Distinct from what is claimable, which lives on chain in campaign_claims. This endpoint answers "what have I earned"; the chain answers "what can I take". Keeping them apart is what makes "accrued but not yet swept" and "accrued but forfeited" answerable without trusting either side alone.

accrued_this_week_usd
number<double>
required

Accrued since Monday. This is what the weekly sweep will pay, or forfeit.

accrued_today_usd
number<double>
required

Accrued so far today. Provisional until the week is swept.

current_nuv_usd
number<double>
required

The trailing-window NUV that rung was derived from.

current_tier
string
required

The rung in force, from the most recent accrual. bronze when there is no history: an affiliate whose network brings nobody new still earns, at the lowest rate.

days
object[]
required

Daily breakdown, oldest first. Days with no activity are absent, not zero-filled.

lifetime_accrued_usd
number<double>
required

Accrued over all time, including weeks already paid.

meets_minimum
boolean
required

Whether the running week currently clears the floor

minimum_payout_usd
number<double>
required

The floor a week must clear to be paid at all

mode
string
required

points | usd: the reward mode in force today — the affiliate's most recent election whose effective_from has already arrived. Read from the election ledger, not from the latest accrual, so it flips the instant an election takes effect rather than lagging until the next accrual is written. Absent history reads points, the status quo for every affiliate today.

nuv_window_days
integer<int32>
required

Days in the NUV window. Sent so the caller can label it without hardcoding 30.

Required range: x >= 0
pending_effective_from
string
required

The Monday pending_mode starts, YYYY-MM-DD, or empty when nothing is pending.

pending_mode
string
required

A recorded election that has not taken effect yet, or empty.

Published because mode alone cannot express it. An election lands on a future Monday, so between signing it and that day the affiliate is still earning the old currency and the ledger still stamps it — a screen reading only mode shows no trace of a decision that has already been made, irreversibly. The affiliate concludes it failed and tries again.

previous_week_campaign_id
integer<int64>
required

On-chain campaign carrying the previous week, or 0 when it is not on chain yet. A non-zero id means the money is claimable through the campaigns endpoints, not here.

Required range: x >= 0
previous_week_status
string
required

What the sweep decided about that week: paid, forfeited, withheld, or empty when it has not been swept yet. Empty is the common case early in a week.

previous_week_usd
number<double>
required

Accrued over the week before this one. Non-zero for the two or three days between a week closing and its sweep paying out — the window in which the running week reads near zero while real money is still owed.

progress_to_minimum
number<double>
required

0.0–1.0 progress toward the floor, for a progress indicator

tiers
object[]
required

The whole ladder, highest rung first. Static config, published so no client keeps a second copy of the rate table.

week_start_date
string
required

Monday of the running week, YYYY-MM-DD

weeks
object[]
required

Weekly history, newest first: what each week accrued and what the sweep decided.

Separate from days because the two answer different questions — days is how the figure was built, weeks is what happened to it.