Create order tag
curl --request POST \
--url https://api.orderly.org/v1/broker/order_enum \
--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 '
{
"enum_id": "STRATEGY_DCA",
"default_fee_rate": 0.005,
"name": "DCA Strategy",
"description": "Dollar Cost Averaging strategy orders",
"pair_overrides": {
"PERP_BTC_USDC": 0.003
}
}
'import requests
url = "https://api.orderly.org/v1/broker/order_enum"
payload = {
"enum_id": "STRATEGY_DCA",
"default_fee_rate": 0.005,
"name": "DCA Strategy",
"description": "Dollar Cost Averaging strategy orders",
"pair_overrides": { "PERP_BTC_USDC": 0.003 }
}
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({
enum_id: 'STRATEGY_DCA',
default_fee_rate: 0.005,
name: 'DCA Strategy',
description: 'Dollar Cost Averaging strategy orders',
pair_overrides: {PERP_BTC_USDC: 0.003}
})
};
fetch('https://api.orderly.org/v1/broker/order_enum', 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/broker/order_enum",
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([
'enum_id' => 'STRATEGY_DCA',
'default_fee_rate' => 0.005,
'name' => 'DCA Strategy',
'description' => 'Dollar Cost Averaging strategy orders',
'pair_overrides' => [
'PERP_BTC_USDC' => 0.003
]
]),
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/broker/order_enum"
payload := strings.NewReader("{\n \"enum_id\": \"STRATEGY_DCA\",\n \"default_fee_rate\": 0.005,\n \"name\": \"DCA Strategy\",\n \"description\": \"Dollar Cost Averaging strategy orders\",\n \"pair_overrides\": {\n \"PERP_BTC_USDC\": 0.003\n }\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/broker/order_enum")
.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 \"enum_id\": \"STRATEGY_DCA\",\n \"default_fee_rate\": 0.005,\n \"name\": \"DCA Strategy\",\n \"description\": \"Dollar Cost Averaging strategy orders\",\n \"pair_overrides\": {\n \"PERP_BTC_USDC\": 0.003\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orderly.org/v1/broker/order_enum")
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 \"enum_id\": \"STRATEGY_DCA\",\n \"default_fee_rate\": 0.005,\n \"name\": \"DCA Strategy\",\n \"description\": \"Dollar Cost Averaging strategy orders\",\n \"pair_overrides\": {\n \"PERP_BTC_USDC\": 0.003\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"timestamp": 1702989203989
}Order tag admin
Create order tag
Limit: 1 request per second
POST /v1/broker/order_enum
Create a new order tag fee config. The fee config identifier is enum_id; the order tag value sent on orders is enum:<enum_id>.
POST
/
v1
/
broker
/
order_enum
Create order tag
curl --request POST \
--url https://api.orderly.org/v1/broker/order_enum \
--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 '
{
"enum_id": "STRATEGY_DCA",
"default_fee_rate": 0.005,
"name": "DCA Strategy",
"description": "Dollar Cost Averaging strategy orders",
"pair_overrides": {
"PERP_BTC_USDC": 0.003
}
}
'import requests
url = "https://api.orderly.org/v1/broker/order_enum"
payload = {
"enum_id": "STRATEGY_DCA",
"default_fee_rate": 0.005,
"name": "DCA Strategy",
"description": "Dollar Cost Averaging strategy orders",
"pair_overrides": { "PERP_BTC_USDC": 0.003 }
}
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({
enum_id: 'STRATEGY_DCA',
default_fee_rate: 0.005,
name: 'DCA Strategy',
description: 'Dollar Cost Averaging strategy orders',
pair_overrides: {PERP_BTC_USDC: 0.003}
})
};
fetch('https://api.orderly.org/v1/broker/order_enum', 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/broker/order_enum",
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([
'enum_id' => 'STRATEGY_DCA',
'default_fee_rate' => 0.005,
'name' => 'DCA Strategy',
'description' => 'Dollar Cost Averaging strategy orders',
'pair_overrides' => [
'PERP_BTC_USDC' => 0.003
]
]),
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/broker/order_enum"
payload := strings.NewReader("{\n \"enum_id\": \"STRATEGY_DCA\",\n \"default_fee_rate\": 0.005,\n \"name\": \"DCA Strategy\",\n \"description\": \"Dollar Cost Averaging strategy orders\",\n \"pair_overrides\": {\n \"PERP_BTC_USDC\": 0.003\n }\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/broker/order_enum")
.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 \"enum_id\": \"STRATEGY_DCA\",\n \"default_fee_rate\": 0.005,\n \"name\": \"DCA Strategy\",\n \"description\": \"Dollar Cost Averaging strategy orders\",\n \"pair_overrides\": {\n \"PERP_BTC_USDC\": 0.003\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orderly.org/v1/broker/order_enum")
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 \"enum_id\": \"STRATEGY_DCA\",\n \"default_fee_rate\": 0.005,\n \"name\": \"DCA Strategy\",\n \"description\": \"Dollar Cost Averaging strategy orders\",\n \"pair_overrides\": {\n \"PERP_BTC_USDC\": 0.003\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"timestamp": 1702989203989
}Headers
Timestamp of the signed request in milliseconds.
Account ID of the authenticated account.
Public orderly key used to sign the request.
Signature of the request payload generated with the orderly key.
Body
application/json
Fee config ID. UPPERCASE alphanumeric + underscores, max 31 chars. To apply it to an order, set order_tag to enum:<enum_id>.
Example:
"STRATEGY_DCA"
0.00001 to 0.01 (0.001% to 1%)
Example:
0.005
Example:
"DCA Strategy"
Example:
"Dollar Cost Averaging strategy orders"
Show child attributes
Show child attributes
Example:
{ "PERP_BTC_USDC": 0.003 }⌘I