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": "GRID_PRO",
  "name": "Grid Pro",
  "default_fee_rate": 0.005,
  "description": "Grid strategy orders",
  "pair_overrides": {
    "PERP_BTC_USDC": 0.003
  }
}
'

import requests

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

payload = {
    "enum_id": "GRID_PRO",
    "name": "Grid Pro",
    "default_fee_rate": 0.005,
    "description": "Grid 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: 'GRID_PRO',
    name: 'Grid Pro',
    default_fee_rate: 0.005,
    description: 'Grid 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' => 'GRID_PRO',
    'name' => 'Grid Pro',
    'default_fee_rate' => 0.005,
    'description' => 'Grid 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\": \"GRID_PRO\",\n  \"name\": \"Grid Pro\",\n  \"default_fee_rate\": 0.005,\n  \"description\": \"Grid 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\": \"GRID_PRO\",\n  \"name\": \"Grid Pro\",\n  \"default_fee_rate\": 0.005,\n  \"description\": \"Grid 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\": \"GRID_PRO\",\n  \"name\": \"Grid Pro\",\n  \"default_fee_rate\": 0.005,\n  \"description\": \"Grid 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 custom trading fee configuration owned by the authenticated broker. enum_id is unique within that broker and immutable.

To submit a new order with this enum, construct order_tag as enum:<authenticated_broker_id>:<enum_id>.

The default active-enum limit is 10 per owning broker and is deployment-configurable.

Existing fee configurations share the same active-configuration pool regardless of which tag format historical orders used.

Common errors:

Code	Meaning
`-1201`	Enum ID already exists for this owner.
`-1206`	Active enum limit reached.
`-1207`	Enum ID format is invalid.
`-1208`	Fee rate is invalid.
`-1209`	Enum ID is longer than 36 characters.
`-1210`	A pair override symbol is invalid.

POST

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": "GRID_PRO",
  "name": "Grid Pro",
  "default_fee_rate": 0.005,
  "description": "Grid strategy orders",
  "pair_overrides": {
    "PERP_BTC_USDC": 0.003
  }
}
'

import requests

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

payload = {
    "enum_id": "GRID_PRO",
    "name": "Grid Pro",
    "default_fee_rate": 0.005,
    "description": "Grid 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: 'GRID_PRO',
    name: 'Grid Pro',
    default_fee_rate: 0.005,
    description: 'Grid 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' => 'GRID_PRO',
    'name' => 'Grid Pro',
    'default_fee_rate' => 0.005,
    'description' => 'Grid 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\": \"GRID_PRO\",\n  \"name\": \"Grid Pro\",\n  \"default_fee_rate\": 0.005,\n  \"description\": \"Grid 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\": \"GRID_PRO\",\n  \"name\": \"Grid Pro\",\n  \"default_fee_rate\": 0.005,\n  \"description\": \"Grid 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\": \"GRID_PRO\",\n  \"name\": \"Grid Pro\",\n  \"default_fee_rate\": 0.005,\n  \"description\": \"Grid 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

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

enum_id

string

required

Unprefixed enum ID. Uppercase letters, digits, and underscores only; unique within the authenticated owner broker and immutable. To apply it to a new order, set order_tag to enum:<owner_broker_id>:<enum_id>.

Required string length: 1 - 36

Pattern: ^[A-Z0-9_]+$

Example:

"GRID_PRO"

name

string

required

Human-readable enum name.

Example:

"Grid Pro"

default_fee_rate

number

required

Default enum fee rate. Must be 0.00001 through 0.01 (0.001% through 1%) with at most five decimal places.

Required range: 0.00001 <= x <= 0.01Must be a multiple of 0.00001

Example:

0.005

description

string

Human-readable purpose of the enum.

Example:

"Grid strategy orders"

pair_overrides

object

Optional symbol-to-fee-rate map. Every symbol must exist, and every rate must satisfy the same limits as default_fee_rate.

Show child attributes

Example:

{ "PERP_BTC_USDC": 0.003 }

Response

200 - application/json

success

boolean

required

Indicates whether the request was successful.

Example:

true

timestamp

integer

Server timestamp in milliseconds.

Example:

1702989203989

Builder quickstart

Partner onboarding & support

Core integration flows

Perp Anything

Orderly Predict

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

Create order tag

Headers

Body

Response