Referrals

public/get_referral_performance

Returns broker-program referral performance for a referral code, identified either by the code itself or by the referrer's wallet, over a requested time window (start_ms to end_ms, capped at 28 days). The response includes total notional volume, referred fees, fee rewards, builder fees collected, the applicable fee-share percentage, and a per-role/currency/instrument-type breakdown, all as decimal strings.

post/public/get_referral_performance

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/public/get_referral_performance
  • Auth: none declared

Request body

end_msinteger required

End timestamp in UTC milliseconds.

referral_codestring nullable

(Optional) referral code.

start_msinteger required

Start timestamp in UTC milliseconds.

walletstring nullable

(Optional) wallet of the referrer.

Response

Success

fee_share_percentagestring required
referral_codestring required
rewardsobject required

Performance by liquidity role / currency / instrument type.

stdrv_balancestring required
total_builder_fee_collectedstring required
total_fee_rewardsstring required
total_notional_volumestring required
total_referred_feesstring required

Changes

No recorded changes to this operation across all 1 revision of this API.