Skip to main content
GET
/
v1
/
referral
/
admin_info
Get referral code info
curl --request GET \
  --url https://api.orderly.org/v1/referral/admin_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": {
    "rows": [
      {
        "account_id": "0x114f583aea808c5812e16109b6c087660285a26f0a31dcc0f9b54f1a6a0fefbd",
        "user_address": "0xa8ec6970fec8842dd229eef170f624c3d77dab45",
        "number_of_codes": "1",
        "total_invites": 0.03,
        "total_traded": 0.01,
        "referee_volume": 0.01,
        "referee_fee": 0.01,
        "orderly_fee": 1111,
        "referral_codes": [
          {
            "code": "C4",
            "max_rebate_rate": 0.4,
            "referrer_rebate_rate": 0.3,
            "referee_rebate_rate": 0.1,
            "total_referrer_rebate": 123.456,
            "total_referee_rebate": 123.456
          }
        ]
      }
    ],
    "meta": {
      "records_per_page": 25,
      "current_page": 1,
      "total": 50
    }
  },
  "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.

Query Parameters

​
page
string

start from 1

​
size
string

Only one of user_address and account_id can be provided

​
user_address
string
​
account_id
string

Only one of user_address and account_id can be provided

​
sort_by
string

total_invites/total_traded/referee_volume descending

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