Skip to main content
GET
/
api
/
v1
/
referrals
/
stats
/
{account}
Handler to get referrer statistics. Non-affiliate referrers must meet the minimum trade volume threshold to see their referral codes. Affiliate referrers always see all codes.
curl --request GET \
  --url https://api.mainnet.aptoslabs.com/decibel/api/v1/referrals/stats/{account} \
  --header 'Authorization: Bearer <token>'
{
  "codes": [
    "<string>"
  ],
  "is_affiliate": true,
  "referrer_account": "<string>",
  "total_codes_created": 1,
  "total_referrals": 1,
  "volume_threshold_met": true
}

Authorizations

​
Authorization
string
header
required

Bearer token from Geomi. See Authentication for setup instructions.

Path Parameters

​
account
string
required

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

Response

Successfully retrieved referrer stats

Referrer statistics — aggregate stats for a referrer account

​
codes
string[]
required

List of referral codes visible to this referrer. Non-affiliate referrers must meet the volume threshold to see their codes.

​
is_affiliate
boolean
required

Whether this referrer has any affiliate-designated codes. Affiliates always see all their codes regardless of trade volume.

​
referrer_account
string
required

The referrer's wallet address

​
total_codes_created
integer<int64>
required

Total number of referral codes created by this referrer. Always accurate regardless of code visibility (non-affiliates below the volume threshold will see an empty codes array but this still reflects the true count).

Required range: x >= 0
​
total_referrals
integer<int64>
required

Total number of users referred

Required range: x >= 0
​
volume_threshold_met
boolean
required

Whether the account meets the minimum trade volume threshold to see non-affiliate referral codes