Create order enum

Limit: 1 request per second

POST /v1/broker/order_enum

Create a new order enum.

POST /v1/broker/order_enum

Create order enum

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": "STRATEGY_DCA",
  "default_fee_rate": 0.005,
  "name": "DCA Strategy",
  "description": "Dollar Cost Averaging 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

UPPERCASE alphanumeric + underscores, max 31 chars

Example:

"STRATEGY_DCA"

default_fee_rate · number · required

0.00001 to 0.01 (0.001% to 1%)

Example:

0.005

name · string

Example:

"DCA Strategy"

description · string

Example:

"Dollar Cost Averaging strategy orders"

pair_overrides · object

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