Create/update stage parameters
curl --request POST \
--url https://api.orderly.org/v1/admin/points/stage \
--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 '
{
"stage_name": "<string>",
"start_date": "<string>",
"volume_boost": 123,
"pnl_boost": 123,
"l1_referral_boost": 123,
"l2_referral_boost": 123,
"is_continous": true,
"stage_id": 123,
"end_date": "<string>"
}
'import requests
url = "https://api.orderly.org/v1/admin/points/stage"
payload = {
"stage_name": "<string>",
"start_date": "<string>",
"volume_boost": 123,
"pnl_boost": 123,
"l1_referral_boost": 123,
"l2_referral_boost": 123,
"is_continous": True,
"stage_id": 123,
"end_date": "<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({
stage_name: '<string>',
start_date: '<string>',
volume_boost: 123,
pnl_boost: 123,
l1_referral_boost: 123,
l2_referral_boost: 123,
is_continous: true,
stage_id: 123,
end_date: '<string>'
})
};
fetch('https://api.orderly.org/v1/admin/points/stage', 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/admin/points/stage",
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([
'stage_name' => '<string>',
'start_date' => '<string>',
'volume_boost' => 123,
'pnl_boost' => 123,
'l1_referral_boost' => 123,
'l2_referral_boost' => 123,
'is_continous' => true,
'stage_id' => 123,
'end_date' => '<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/admin/points/stage"
payload := strings.NewReader("{\n \"stage_name\": \"<string>\",\n \"start_date\": \"<string>\",\n \"volume_boost\": 123,\n \"pnl_boost\": 123,\n \"l1_referral_boost\": 123,\n \"l2_referral_boost\": 123,\n \"is_continous\": true,\n \"stage_id\": 123,\n \"end_date\": \"<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/admin/points/stage")
.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 \"stage_name\": \"<string>\",\n \"start_date\": \"<string>\",\n \"volume_boost\": 123,\n \"pnl_boost\": 123,\n \"l1_referral_boost\": 123,\n \"l2_referral_boost\": 123,\n \"is_continous\": true,\n \"stage_id\": 123,\n \"end_date\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orderly.org/v1/admin/points/stage")
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 \"stage_name\": \"<string>\",\n \"start_date\": \"<string>\",\n \"volume_boost\": 123,\n \"pnl_boost\": 123,\n \"l1_referral_boost\": 123,\n \"l2_referral_boost\": 123,\n \"is_continous\": true,\n \"stage_id\": 123,\n \"end_date\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"timestamp": 1702989203989
}Admin API
Create/update stage parameters
Limit: 10 requests per 1 second per user per IP address
POST /v1/admin/points/stage
Create a new stage (series of epochs). Only callable by Broker Admin.
Make sure there’s only 1 active stage at any time.
POST
/
v1
/
admin
/
points
/
stage
Create/update stage parameters
curl --request POST \
--url https://api.orderly.org/v1/admin/points/stage \
--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 '
{
"stage_name": "<string>",
"start_date": "<string>",
"volume_boost": 123,
"pnl_boost": 123,
"l1_referral_boost": 123,
"l2_referral_boost": 123,
"is_continous": true,
"stage_id": 123,
"end_date": "<string>"
}
'import requests
url = "https://api.orderly.org/v1/admin/points/stage"
payload = {
"stage_name": "<string>",
"start_date": "<string>",
"volume_boost": 123,
"pnl_boost": 123,
"l1_referral_boost": 123,
"l2_referral_boost": 123,
"is_continous": True,
"stage_id": 123,
"end_date": "<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({
stage_name: '<string>',
start_date: '<string>',
volume_boost: 123,
pnl_boost: 123,
l1_referral_boost: 123,
l2_referral_boost: 123,
is_continous: true,
stage_id: 123,
end_date: '<string>'
})
};
fetch('https://api.orderly.org/v1/admin/points/stage', 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/admin/points/stage",
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([
'stage_name' => '<string>',
'start_date' => '<string>',
'volume_boost' => 123,
'pnl_boost' => 123,
'l1_referral_boost' => 123,
'l2_referral_boost' => 123,
'is_continous' => true,
'stage_id' => 123,
'end_date' => '<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/admin/points/stage"
payload := strings.NewReader("{\n \"stage_name\": \"<string>\",\n \"start_date\": \"<string>\",\n \"volume_boost\": 123,\n \"pnl_boost\": 123,\n \"l1_referral_boost\": 123,\n \"l2_referral_boost\": 123,\n \"is_continous\": true,\n \"stage_id\": 123,\n \"end_date\": \"<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/admin/points/stage")
.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 \"stage_name\": \"<string>\",\n \"start_date\": \"<string>\",\n \"volume_boost\": 123,\n \"pnl_boost\": 123,\n \"l1_referral_boost\": 123,\n \"l2_referral_boost\": 123,\n \"is_continous\": true,\n \"stage_id\": 123,\n \"end_date\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orderly.org/v1/admin/points/stage")
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 \"stage_name\": \"<string>\",\n \"start_date\": \"<string>\",\n \"volume_boost\": 123,\n \"pnl_boost\": 123,\n \"l1_referral_boost\": 123,\n \"l2_referral_boost\": 123,\n \"is_continous\": true,\n \"stage_id\": 123,\n \"end_date\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"timestamp": 1702989203989
}Headers
Body
application/json
Name of the stage
Start date (YYYY-MM-DD)
Volume boost factor
PnL boost factor
Level 1 Referral boost factor
Level 2 Referral boost factor
If provided, update this stage; if empty, create a new stage
End date (YYYY-MM-DD), optional for indefinite
⌘I