Skip to main content
GET
/
v1
/
referral
/
multi_level
/
admin
/
summary
Get multilevel summary info
curl --request GET \
  --url https://api.orderly.org/v1/referral/multi_level/admin/summary \
  --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": "<string>",
        "user_address": "<string>",
        "total_direct_invites": 123,
        "total_indirect_invites": 123,
        "total_invites": 123,
        "total_direct_traded": 123,
        "total_indirect_traded": 123,
        "total_direct_volume": 123,
        "total_indirect_volume": 123,
        "total_volume": 123,
        "broker_fee": 123,
        "total_direct_rebate": 123,
        "total_indirect_rebate": 123,
        "total_direct_bonus_rebate": 123,
        "date": "<string>"
      }
    ],
    "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

start_date
string
required

Start date (YYYY-MM-DD)

end_date
string
required

End date (YYYY-MM-DD)

page
integer

Page number, default 1

size
integer

Page size, default 20

aggregate_by
enum<string>
required

Aggregate by: date, account_id

Available options:
date,
account_id
account_id
string

Only one of account_id and user_address can be provided

user_address
string

Only one of account_id and user_address can be provided

sort_by
string

Sort by field: broker_fee, total_volume, total_invites

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