DEdecibel
Referrals

Get an affiliate's accrued commission

Changed on

What the affiliate has earned: today, since Monday, and over all time, plus a daily breakdown carrying the tier and any anti-farming penalty that was in force each day.

This is not what is claimable. Claimable commission is an on-chain campaign allocation and comes from the campaigns endpoints; this is the off-chain ledger of what is owed.

get/api/v1/referrals/commissions

Request

Query parameters

affiliate_accountstring required

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

daysinteger

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

Response

The affiliate's accrued commission

accrued_this_week_usdnumber double required

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

accrued_today_usdnumber double required

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

current_nuv_usdnumber double required

The trailing-window NUV that rung was derived from.

current_tierstring 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.

lifetime_accrued_usdnumber double required

Accrued over all time, including weeks already paid.

meets_minimumboolean required

Whether the running week currently clears the floor

minimum_payout_usdnumber double required

The floor a week must clear to be paid at all

modestring 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_daysinteger required

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

pending_effective_fromstring required

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

pending_modestring 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_idinteger 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.

previous_week_statusstring 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_usdnumber 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_minimumnumber double required

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

week_start_datestring required

Monday of the running week, YYYY-MM-DD

Changes