Skip to main content
GET
/
v1
/
referral
/
info
Get referral info
curl --request GET \
  --url https://api.orderly.org/v1/referral/info \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
{
  "success": true,
  "data": {
    "referrer_info": {
      "1d_invites": 5,
      "7d_invites": 5,
      "30d_invites": 5,
      "total_invites": 30,
      "1d_traded": 5,
      "7d_traded": 10,
      "30d_traded": 20,
      "total_traded": 25,
      "1d_referee_volume": 5,
      "7d_referee_volume": 10,
      "30d_referee_volume": 20,
      "total_referee_volume": 30,
      "1d_referrer_rebate": 5,
      "7d_referrer_rebate": 10,
      "30d_referrer_rebate": 20,
      "total_referrer_rebate": 30,
      "referral_codes": [
        {
          "code": "C4",
          "max_rebate_rate": 0.4,
          "referrer_rebate_rate": 0.3,
          "referee_rebate_rate": 0.1,
          "total_invites": 30,
          "total_traded": 25
        }
      ]
    },
    "referee_info": {
      "referer_code": "Kevin",
      "referee_rebate_rate": 0.1,
      "1d_referee_rebate": 5,
      "7d_referee_rebate": 10,
      "30d_referee_rebate": 20,
      "total_referee_rebate": 30
    }
  },
  "timestamp": 1702989203989
}

Headers

​
orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

​
orderly-account-id
string
required

Account ID of the authenticated account.

​
orderly-key
string
required

Public orderly key used to sign the request.

​
orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
data
object
required
​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989