RIrise
Invite

Get referral summary

Changed on

Get aggregate referral statistics: total referred volume, activated traders count, and code-status counts (active / redeemed / expired / expiring within 24h).

get/v1/invite/referrals/summary/{account}

Request

Path parameters

accountstring required

Response

A successful response.

total_referred_volumestring

Lifetime sum across all invitees of (maker + taker) non-liquidation match volume. Human-readable decimal string, e.g. "1234567.89".

activated_tradersinteger

Count of invitees whose accounts.status = ACTIVE.

active_codesinteger
redeemed_codesinteger
expired_codesinteger

DEPRECATED: redemptions no longer expire. Always 0; kept for FE back-compat and will be removed once the FE drops them.

expiring_soon_codesinteger
referred_volume_all_time_makerstring

Lifetime maker / taker split of invitees' non-liquidation match volume. Mirrors invitees_volume_all_time_maker/_taker on GetInviteAccountResponse, which are now deprecated and will be removed after FE migrates.

referred_volume_all_time_takerstring

Changes