Get multilevel info

curl --request GET \
  --url https://api.orderly.org/v1/referral/multi_level/admin/info \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'

import requests

url = "https://api.orderly.org/v1/referral/multi_level/admin/info"

headers = {
    "orderly-timestamp": "<orderly-timestamp>",
    "orderly-account-id": "<orderly-account-id>",
    "orderly-key": "<orderly-key>",
    "orderly-signature": "<orderly-signature>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'orderly-timestamp': '<orderly-timestamp>',
    'orderly-account-id': '<orderly-account-id>',
    'orderly-key': '<orderly-key>',
    'orderly-signature': '<orderly-signature>'
  }
};

fetch('https://api.orderly.org/v1/referral/multi_level/admin/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orderly.org/v1/referral/multi_level/admin/info",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "orderly-account-id: <orderly-account-id>",
    "orderly-key: <orderly-key>",
    "orderly-signature: <orderly-signature>",
    "orderly-timestamp: <orderly-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orderly.org/v1/referral/multi_level/admin/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("orderly-timestamp", "<orderly-timestamp>")
	req.Header.Add("orderly-account-id", "<orderly-account-id>")
	req.Header.Add("orderly-key", "<orderly-key>")
	req.Header.Add("orderly-signature", "<orderly-signature>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.orderly.org/v1/referral/multi_level/admin/info")
  .header("orderly-timestamp", "<orderly-timestamp>")
  .header("orderly-account-id", "<orderly-account-id>")
  .header("orderly-key", "<orderly-key>")
  .header("orderly-signature", "<orderly-signature>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/referral/multi_level/admin/info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "timestamp": 1702989203989,
  "data": {
    "rows": [
      {
        "account_id": "<string>",
        "user_address": "<string>",
        "referral_code": "<string>",
        "referrer_account_id": "<string>",
        "referrer_address": "<string>",
        "bound_code": "<string>",
        "level": 123,
        "max_rebate_rate": 123,
        "bonus_max_rebate_rate": 123,
        "default_referee_rebate_rate": 123,
        "default_bonus_referee_rebate_rate": 123,
        "direct_bonus_rebate_rate": 123,
        "base_rebate_rate": 123,
        "total_direct_invites": 123,
        "total_indirect_invites": 123,
        "total_direct_traded": 123,
        "total_indirect_traded": 123,
        "total_direct_volume": 123,
        "total_indirect_volume": 123,
        "broker_fee": 123,
        "total_direct_rebate": 123,
        "total_indirect_rebate": 123,
        "total_direct_bonus_rebate": 123,
        "total_base_rebate": 123
      }
    ],
    "meta": "<unknown>"
  }
}

GET

referral

multi_level

admin

info

Get multilevel info

curl --request GET \
  --url https://api.orderly.org/v1/referral/multi_level/admin/info \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'

import requests

url = "https://api.orderly.org/v1/referral/multi_level/admin/info"

headers = {
    "orderly-timestamp": "<orderly-timestamp>",
    "orderly-account-id": "<orderly-account-id>",
    "orderly-key": "<orderly-key>",
    "orderly-signature": "<orderly-signature>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'orderly-timestamp': '<orderly-timestamp>',
    'orderly-account-id': '<orderly-account-id>',
    'orderly-key': '<orderly-key>',
    'orderly-signature': '<orderly-signature>'
  }
};

fetch('https://api.orderly.org/v1/referral/multi_level/admin/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orderly.org/v1/referral/multi_level/admin/info",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "orderly-account-id: <orderly-account-id>",
    "orderly-key: <orderly-key>",
    "orderly-signature: <orderly-signature>",
    "orderly-timestamp: <orderly-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orderly.org/v1/referral/multi_level/admin/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("orderly-timestamp", "<orderly-timestamp>")
	req.Header.Add("orderly-account-id", "<orderly-account-id>")
	req.Header.Add("orderly-key", "<orderly-key>")
	req.Header.Add("orderly-signature", "<orderly-signature>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.orderly.org/v1/referral/multi_level/admin/info")
  .header("orderly-timestamp", "<orderly-timestamp>")
  .header("orderly-account-id", "<orderly-account-id>")
  .header("orderly-key", "<orderly-key>")
  .header("orderly-signature", "<orderly-signature>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/referral/multi_level/admin/info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "timestamp": 1702989203989,
  "data": {
    "rows": [
      {
        "account_id": "<string>",
        "user_address": "<string>",
        "referral_code": "<string>",
        "referrer_account_id": "<string>",
        "referrer_address": "<string>",
        "bound_code": "<string>",
        "level": 123,
        "max_rebate_rate": 123,
        "bonus_max_rebate_rate": 123,
        "default_referee_rebate_rate": 123,
        "default_bonus_referee_rebate_rate": 123,
        "direct_bonus_rebate_rate": 123,
        "base_rebate_rate": 123,
        "total_direct_invites": 123,
        "total_indirect_invites": 123,
        "total_direct_traded": 123,
        "total_indirect_traded": 123,
        "total_direct_volume": 123,
        "total_indirect_volume": 123,
        "broker_fee": 123,
        "total_direct_rebate": 123,
        "total_indirect_rebate": 123,
        "total_direct_bonus_rebate": 123,
        "total_base_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

user_address

string

Only one of user_address and account_id can be provided

account_id

string

Only one of user_address and account_id can be provided

referrer_account

string

Only one of referrer_account and referrer_address can be provided

referrer_address

string

Only one of referrer_account and referrer_address can be provided

page

integer

Page number

size

integer

Page size

sort_by

enum<string>

Sort by field

Available options:

total_invites,

total_traded,

referee_volume,

bonus_max_rebate_rate

level

integer

Return all if not provided

Response

200 - application/json

success

boolean

required

Indicates whether the request was successful.

Example:

true

timestamp

integer

Server timestamp in milliseconds.

Example:

1702989203989

data

object

Show child attributes

⌘I

Builder quickstart

Partner onboarding & support

Core integration flows

Perp Anything

Builders Marketplace

API fundamentals

Public Info API

General API

User API

Trading API

Strategy vault API

Staking & VALOR API

Builder API

Points module

Market data API

Websocket API

Get multilevel info

Headers

Query Parameters

Response