Skip to main content
GET
/
v1
/
referral
/
multi_level
/
referee_list
Get referee list
curl --request GET \
  --url https://api.orderly.org/v1/referral/multi_level/referee_list \
  --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": [
      {
        "address": "<string>",
        "account_id": "<string>",
        "code_binding_time": 123,
        "bind_code": "<string>",
        "referral_rebate_rate": 123,
        "referee_rebate_rate": 123,
        "is_default_rate": true,
        "direct_invites": 123,
        "indirect_invites": 123,
        "direct_volume": 123,
        "indirect_volume": 123,
        "direct_rebate": 123,
        "indirect_rebate": 123,
        "direct_bonus_rebate": 123
      }
    ],
    "meta": "<unknown>"
  }
}

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
integer

Page number

​
size
integer

Page size

​
address
string

Filter by address

​
sort_by
string

Sort by field: code_binding_time, referral_rebate_rate, referee_rebate_rate, direct_invites, indirect_invites, direct_volume, indirect_volume

​
sort_order
string

Sort order: ascending, descending

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989

​
data
object