Get Account Referral

Get the authenticated account's invite code, parent referral code, direct referral count, and fee share rate.

get/v1/account/referral

Response

Account referral response.

codestring required

Referral or invite code

parentstring

Referral or invite code

children_countinteger required

Number of directly referred child accounts

active_children_countinteger required

Number of directly referred child accounts that have traded at least once since their referral was applied

children_volumestring required

Total notional volume traded by directly referred child accounts since their referral was applied

children_feesstring required

Total fees paid by directly referred child accounts since their referral was applied

referrals_leftinteger required

Number of additional referrals remaining for this account's invite code

fee_share_ratestring required

Referral fee share rate. Defaults to 0.2.

Example response

{
  "code": "ABC123",
  "parent": "ABC123",
  "children_count": 12,
  "active_children_count": 8,
  "children_volume": "125000.50",
  "children_fees": "312.75",
  "referrals_left": 11,
  "fee_share_rate": "0.2"
}

Changes

Changed in 1 of the 7 revisions of this API.3

Jul 31, 2026953ba055eaeb3See the full diff
- ○
  added the required property active_children_count to the response with the 200 status
  response-required-property-added
- ○
  added the required property children_fees to the response with the 200 status
  response-required-property-added
- ○
  added the required property children_volume to the response with the 200 status
  response-required-property-added

Full history