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 /v1/broker/order_enum

Create order tag

cURL

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
  }
}
'

200

{
  "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

OK

success · boolean · required

Indicates whether the request was successful.

Example:

true

timestamp · integer

Server timestamp in milliseconds.

Example:

1702989203989