Referral Program
Get Referral Code Info
- Accounts
- Wallet Authentication
- Deposit/Withdrawal
- Settle PnL
- Order Management
- Custom Fee Structure
- Delegate Signer
- Referral System
- Broker Info
- System Info
- USDC Faucet
- Registration
- Key Management
- Account/User Info
- Account Notifications
- Account Config
- Delegate Signer
- Order Management
- Liquidations
- Assets/Withdraw/Settle PnL
- Positions
- Funding
- User Data
- Trading Campaigns
- Fee Setting
- Points Campaign
- Referral Program
- GETCheck Referral Code
- POSTCreate Referral Code
- GETVerify Referral Code
- GETGet Referral Code Info
- POSTUpdate Referral Code
- POSTBind Referral Code
- GETGet Referral Info
- GETGet Referee Info
- GETGet Referee Rebate Summary
- GETGet Referee History
- GETGet Referral History
- GETGet Referral Rebate Summary
- GETGet Distribution History
- POSTEdit Referral Code Split
- GET
- TradingView
- Funding Rates
- Market Info
User Flows
General API
User API
Trading API
Broker API
Market Data API
Referral Program
Get Referral Code Info
Limit: 10 requests per second
GET /v1/referral/admin_info
Scope: Only each broker_id’s admin wallet can call this endpoint.
GET
/
v1
/
referral
/
admin_info
orderly-timestamp
string
*
orderly-timestamp
Required
string
orderly-account-id
string
*
orderly-account-id
Required
string
orderly-key
string
*
orderly-key
Required
string
orderly-signature
string
*
orderly-signature
Required
string
page
string
page
string
size
string
size
string
Only one of user_address
and account_id
can be provided
user_address
string
user_address
string
account_id
string
account_id
string
Only one of user_address
and account_id
can be provided
curl --request GET \
--url https://api-evm.orderly.network/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,
"timestamp": 1702989203989,
"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,
"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
}
}
}
Headers
orderly-timestamp
string
requiredorderly-account-id
string
requiredorderly-key
string
requiredorderly-signature
string
requiredQuery Parameters
page
string
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
Response
200 - application/json
success
boolean
requiredtimestamp
integer
data
object
requireddata.rows
object[]
requireddata.rows.account_id
string
data.rows.user_address
string
data.rows.number_of_codes
integer
data.rows.total_invites
integer
data.rows.total_traded
number
data.rows.referee_volume
number
data.rows.referee_fee
number
data.rows.referral_codes
object[]
data.rows.referral_codes.code
string
data.rows.referral_codes.max_rebate_rate
number
data.rows.referral_codes.referrer_rebate_rate
number
data.rows.referral_codes.referee_rebate_rate
number
data.rows.referral_codes.total_referrer_rebate
number
data.rows.referral_codes.total_referee_rebate
number
data.meta
object
data.meta.records_per_page
integer
data.meta.current_page
integer
data.meta.total
integer
curl --request GET \
--url https://api-evm.orderly.network/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,
"timestamp": 1702989203989,
"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,
"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
}
}
}