Skip to main content
GET
/
v1
/
referral
/
auto_referral
/
info
Builder admin get auto referral info
curl --request GET \
  --url https://api.orderly.org/v1/referral/auto_referral/info \
  --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": {
    "required_trading_volume": 10000,
    "max_rebate": 1,
    "referrer_rebate": 0.5,
    "referee_rebate": 0.5,
    "description": "<string>",
    "enable": true
  }
}

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.

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