Referral Program
Get Referee 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 Referee Info
Limit: 10 requests per second
GET /v1/referral/referee_info
GET
/
v1
/
referral
/
referee_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
integer
page
integer
size
integer
size
integer
sort
string
sort
string
ascending_code_binding_time
descending_code_binding_time
ascending_referral_rebate
descending_referral_rebate
ascending_volume
descending_volume
curl --request GET \
--url https://api-evm.orderly.network/v1/referral/referee_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",
"register_time": 1663936930000,
"code_binding_time": 1663936930000,
"referral_code": "C4",
"volume": 1229.12,
"referral_rebate": 2.22,
"trade_status": "Registered"
}
],
"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
integer
size
integer
sort
string
ascending_code_binding_time
descending_code_binding_time
ascending_referral_rebate
descending_referral_rebate
ascending_volume
descending_volume
Response
200 - application/json
success
boolean
requiredtimestamp
integer
data
object
requireddata.rows
object[]
requireddata.rows.account_id
string
account_id of the referee
data.rows.user_address
string
address of the referee
data.rows.register_time
number
register time of the referee
data.rows.code_binding_time
number
the time the referee bind the account to this referral code
data.rows.referral_code
string
the referral code used by the referee
data.rows.volume
number
the total volume traded by the referee
data.rows.referral_rebate
number
the total referral rebate paid to the referer based on the referee's fees paid
data.rows.trade_status
string
Registered
= Not traded but bind the code / Traded
= bind the code and volume > 0
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/referee_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",
"register_time": 1663936930000,
"code_binding_time": 1663936930000,
"referral_code": "C4",
"volume": 1229.12,
"referral_rebate": 2.22,
"trade_status": "Registered"
}
],
"meta": {
"records_per_page": 25,
"current_page": 1,
"total": 50
}
}
}