Method Name
public/get_referral_performance
public/get_referral_performanceGet the broker program referral performance. Epochs are 28 days long.
Parameters
| end_msintegerrequired End timestamp in UTC milliseconds |
| start_msintegerrequired Start timestamp in UTC milliseconds |
| referral_codestring (Optional) referral code |
| walletstring (Optional) wallet of the referrer |
Response
| idstring or integerrequired |
| resultobjectrequired |
| result.fee_share_percentagestringrequired Fee share percentage rewarded to referrer |
| result.referral_codestringrequired Referral code used to get performance |
| result.stdrv_balancestringrequired Staked DRV held used to determine fee share percentage |
| result.total_builder_fee_collectedstringrequired Total builder fee collected (collected using the extra_fee field in orders) |
| result.total_fee_rewardsstringrequired Total fee rewards to referrers |
| result.total_notional_volumestringrequired Total referred notional volume |
| result.total_referred_feesstringrequired Total fees paid by referred traders (double counts if both taker and maker of a trade with rebated fees) |
| result.rewardsobjectrequired Performance by liquidity role / currency / instrument type |
Example
{request_example_shell}{request_example_javascript}{request_example_python}The above command returns JSON structured like this:
{response_example_json}