> ## Documentation Index
> Fetch the complete documentation index at: https://orderly.network/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Orderly network hooks.RefferalAPI

[Orderly SDKs](/sdks/tech-doc/README) / [Modules](/sdks/tech-doc/modules) / [@orderly.network/hooks](/sdks/tech-doc/modules/orderly_network_hooks) / RefferalAPI

# Namespace: RefferalAPI

[@orderly.network/hooks](/sdks/tech-doc/modules/orderly_network_hooks).RefferalAPI

## Table of contents

### Interfaces

* [ReferralInfo](/sdks/tech-doc/interfaces/orderly_network_hooks.RefferalAPI.ReferralInfo)

### Type Aliases

* [DayliVolume](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#daylivolume)
* [Distribution](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#distribution)
* [Referee](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#referee)
* [RefereeInfoItem](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#refereeinfoitem)
* [RefereeRebateSummary](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#refereerebatesummary)
* [ReferralCode](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#referralcode)
* [ReferralRebateSummary](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#referralrebatesummary)
* [Referrer](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#referrer)
* [UserVolStats](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#uservolstats)

## Type Aliases

### DayliVolume

Ƭ **DayliVolume**: `Object`

#### Type declaration

| Name          | Type     |
| :------------ | :------- |
| `date`        | `string` |
| `perp_volume` | `number` |

#### Defined in

[packages/hooks/src/referral/api.ts:93](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/api.ts#L93)

***

### 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](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/api.ts#L70)

***

### 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](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/api.ts#L41)

***

### 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](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/api.ts#L50)

***

### RefereeRebateSummary

Ƭ **RefereeRebateSummary**: `Object`

#### Type declaration

| Name             | Type     |
| :--------------- | :------- |
| `date`           | `string` |
| `fee`            | `number` |
| `referee_rebate` | `number` |

#### Defined in

[packages/hooks/src/referral/api.ts:87](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/api.ts#L87)

***

### 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](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/api.ts#L8)

***

### 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](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/api.ts#L80)

***

### 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`](/sdks/tech-doc/modules/orderly_network_hooks.RefferalAPI#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](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/api.ts#L17)

***

### 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](https://github.com/OrderlyNetwork/js-sdk/blob/ba995f2/packages/hooks/src/referral/api.ts#L63)