Orderly network hooks.RefferalAPI

Orderly SDKs / Modules / @orderly.network/hooks / RefferalAPI

Namespace: RefferalAPI

@orderly.network/hooks.RefferalAPI

Table of contents

Interfaces

• ReferralInfo

Type Aliases

• DayliVolume
• Distribution
• Referee
• RefereeInfoItem
• RefereeRebateSummary
• ReferralCode
• ReferralRebateSummary
• Referrer
• UserVolStats

Type Aliases

DayliVolume

Ƭ DayliVolume: Object

Type declaration

Name	Type
date	string
perp_volume	number

Defined in

packages/hooks/src/referral/api.ts:93

---

Distribution

Ƭ Distribution: Object

Type declaration

Name	Type
amount	number
created_time	number
id	number
status	string
token	string
type	string
updated_time	number

Defined in

packages/hooks/src/referral/api.ts:70

---

Referee

Ƭ Referee: Object

Type declaration

Name	Type
1d_referee_rebate	number
30d_referee_rebate	number
7d_referee_rebate	number
referee_rebate_rate?	number
referer_code?	string
total_referee_rebate	number

Defined in

packages/hooks/src/referral/api.ts:41

---

RefereeInfoItem

Ƭ RefereeInfoItem: Object

Type declaration

Name	Type
account_id	string
code_binding_time	number
fee	number
referral_code	string
referral_rebate	number
register_time	number
trade_status	string
user_address	string
volume	number

Defined in

packages/hooks/src/referral/api.ts:50

---

RefereeRebateSummary

Ƭ RefereeRebateSummary: Object

Type declaration

Name	Type
date	string
fee	number
referee_rebate	number

Defined in

packages/hooks/src/referral/api.ts:87

---

ReferralCode

Ƭ ReferralCode: Object

Type declaration

Name	Type
code	string
max_rebate_rate	number
referee_rebate_rate	number
referrer_rebate_rate	number
total_invites	number
total_traded	number

Defined in

packages/hooks/src/referral/api.ts:8

---

ReferralRebateSummary

Ƭ ReferralRebateSummary: Object

Type declaration

Name	Type
date	string
fee	number
referral_rebate	number
volume	number

Defined in

packages/hooks/src/referral/api.ts:80

---

Referrer

Ƭ Referrer: Object

Type declaration

Name	Type
1d_invites	number
1d_referee_fee	number
1d_referee_volume	number
1d_referrer_rebate	number
1d_traded	number
30d_invites	number
30d_referee_fee	number
30d_referee_volume	number
30d_referrer_rebate	number
30d_traded	number
7d_invites	number
7d_referee_fee	number
7d_referee_volume	number
7d_referrer_rebate	number
7d_traded	number
referral_codes	ReferralCode[]
total_invites	number
total_referee_fee	number
total_referee_volume	number
total_referrer_rebate	number
total_traded	number

Defined in

packages/hooks/src/referral/api.ts:17

---

UserVolStats

Ƭ UserVolStats: Object

Type declaration

Name	Type
perp_volume_last_30_days	number
perp_volume_last_7_days	number
perp_volume_ltd	number
perp_volume_ytd	number

Defined in

packages/hooks/src/referral/api.ts:63