HomeDocumentationAPI Reference
Log In
API Reference

Get Referral Performance

Method Name

public/get_referral_performance

Get the broker program referral performance. Epochs are 28 days long.

Parameters

end_ms integer required
End timestamp in UTC milliseconds
start_ms integer required
Start timestamp in UTC milliseconds
referral_code string
(Optional) referral code
wallet string
(Optional) wallet of the referrer

Response

id string or integer required
result object required
result.fee_share_percentage string required
Fee share percentage rewarded to referrer
result.referral_code string required
Referral code used to get performance
result.stdrv_balance string required
Staked DRV held used to determine fee share percentage
result.total_fee_rewards string required
Total fee rewards to referrers
result.total_notional_volume string required
Total referred notional volume
result.total_referred_fees string required
Total fees paid by referred traders (double counts if both taker and maker of a trade with rebated fees)
result.rewards object required
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}