Skip to main content
PUT
/
v1
/
broker
/
order_enum
/
{enum_id}
Update order tag
curl --request PUT \
  --url https://api.orderly.org/v1/broker/order_enum/{enum_id} \
  --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 '
{
  "name": "DCA Strategy",
  "description": "Dollar Cost Averaging strategy orders",
  "default_fee_rate": 0.005,
  "pair_overrides": {
    "PERP_BTC_USDC": 0.003
  }
}
'
import requests

url = "https://api.orderly.org/v1/broker/order_enum/{enum_id}"

payload = {
    "name": "DCA Strategy",
    "description": "Dollar Cost Averaging strategy orders",
    "default_fee_rate": 0.005,
    "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.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  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({
    name: 'DCA Strategy',
    description: 'Dollar Cost Averaging strategy orders',
    default_fee_rate: 0.005,
    pair_overrides: {PERP_BTC_USDC: 0.003}
  })
};

fetch('https://api.orderly.org/v1/broker/order_enum/{enum_id}', 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/{enum_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'DCA Strategy',
    'description' => 'Dollar Cost Averaging strategy orders',
    'default_fee_rate' => 0.005,
    '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/{enum_id}"

	payload := strings.NewReader("{\n  \"name\": \"DCA Strategy\",\n  \"description\": \"Dollar Cost Averaging strategy orders\",\n  \"default_fee_rate\": 0.005,\n  \"pair_overrides\": {\n    \"PERP_BTC_USDC\": 0.003\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.orderly.org/v1/broker/order_enum/{enum_id}")
  .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  \"name\": \"DCA Strategy\",\n  \"description\": \"Dollar Cost Averaging strategy orders\",\n  \"default_fee_rate\": 0.005,\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/{enum_id}")

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

request = Net::HTTP::Put.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  \"name\": \"DCA Strategy\",\n  \"description\": \"Dollar Cost Averaging strategy orders\",\n  \"default_fee_rate\": 0.005,\n  \"pair_overrides\": {\n    \"PERP_BTC_USDC\": 0.003\n  }\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.

Path Parameters

enum_id
string
required

Fee config ID (enum_id)

Body

application/json
name
string
Example:

"DCA Strategy"

description
string
Example:

"Dollar Cost Averaging strategy orders"

default_fee_rate
number

0.00001 to 0.01 (0.001% to 1%)

Example:

0.005

pair_overrides
object
Example:
{ "PERP_BTC_USDC": 0.003 }

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989