Skip to main content
POST
/
v1
/
referral
/
auto_referral
/
update
Builder admin update auto referral
curl --request POST \
  --url https://api.orderly.org/v1/referral/auto_referral/update \
  --header 'Content-Type: application/json' \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>' \
  --data '
{
  "required_trading_volume": 123,
  "max_rebate": 123,
  "referrer_rebate": 123,
  "referee_rebate": 123,
  "enable": true,
  "description": "<string>"
}
'
import requests

url = "https://api.orderly.org/v1/referral/auto_referral/update"

payload = {
    "required_trading_volume": 123,
    "max_rebate": 123,
    "referrer_rebate": 123,
    "referee_rebate": 123,
    "enable": True,
    "description": "<string>"
}
headers = {
    "orderly-timestamp": "<orderly-timestamp>",
    "orderly-account-id": "<orderly-account-id>",
    "orderly-key": "<orderly-key>",
    "orderly-signature": "<orderly-signature>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'orderly-timestamp': '<orderly-timestamp>',
    'orderly-account-id': '<orderly-account-id>',
    'orderly-key': '<orderly-key>',
    'orderly-signature': '<orderly-signature>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    required_trading_volume: 123,
    max_rebate: 123,
    referrer_rebate: 123,
    referee_rebate: 123,
    enable: true,
    description: '<string>'
  })
};

fetch('https://api.orderly.org/v1/referral/auto_referral/update', 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/auto_referral/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'required_trading_volume' => 123,
    'max_rebate' => 123,
    'referrer_rebate' => 123,
    'referee_rebate' => 123,
    'enable' => true,
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orderly.org/v1/referral/auto_referral/update"

	payload := strings.NewReader("{\n  \"required_trading_volume\": 123,\n  \"max_rebate\": 123,\n  \"referrer_rebate\": 123,\n  \"referee_rebate\": 123,\n  \"enable\": true,\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.orderly.org/v1/referral/auto_referral/update")
  .header("orderly-timestamp", "<orderly-timestamp>")
  .header("orderly-account-id", "<orderly-account-id>")
  .header("orderly-key", "<orderly-key>")
  .header("orderly-signature", "<orderly-signature>")
  .header("Content-Type", "application/json")
  .body("{\n  \"required_trading_volume\": 123,\n  \"max_rebate\": 123,\n  \"referrer_rebate\": 123,\n  \"referee_rebate\": 123,\n  \"enable\": true,\n  \"description\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/referral/auto_referral/update")

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

request = Net::HTTP::Post.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"required_trading_volume\": 123,\n  \"max_rebate\": 123,\n  \"referrer_rebate\": 123,\n  \"referee_rebate\": 123,\n  \"enable\": true,\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "timestamp": 1702989203989
}

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.

Body

application/json
required_trading_volume
number
required
max_rebate
number
required
referrer_rebate
number
required
referee_rebate
number
required
enable
boolean
required
description
string

All users who receive a ref code will see this description displayed in the admin tool.

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989