Skip to main content
GET
Get referral code info

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
string

start from 1

size
string

Only one of user_address and account_id can be provided

user_address
string
account_id
string

Only one of user_address and account_id can be provided

sort_by
string

total_invites/total_traded/referee_volume descending

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

data
object
required
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989