Create algo order

Limit: 1 request per 1 second

POST /v1/algo/order

Place maker/taker order that requires an additional trigger for order execution such as stop orders.

STOP type order bahavior: an order to buy or sell at the market/limit price once the asset has traded at or through a specified price (the “stop price”). If the asset reaches the stop price, the order becomes a market order and is filled at the next available market price.

To place Positional TP/SL order, the input fields is 2 layer and includes an array of the objects named childOrder. The take-profit or stop-loss order should be the objects in the array. For the sub-order in childOrder, please input CLOSE_POSITION as type, and TAKE_PROFIT or STOP_LOSS in algoType field. To place Trailing Stop order, please use TRAILING_STOP as algoType and MARKET as type. Please also input your trailing rate setting in callbackRate field.

Sample request can be found here

Note: This endpoint requires trading scope in orderly key.

POST /v1/algo/order

Create algo order

cURL

curl --request POST \
  --url https://api.orderly.org/v1/algo/order \
  --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 '
[
  {
    "symbol": "PERP_ETH_USDC",
    "algo_type": "BRACKET",
    "quantity": 0.0032,
    "side": "BUY",
    "type": "LIMIT",
    "price": 3415.9,
    "child_orders": [
      {
        "symbol": "PERP_ETH_USDC",
        "algo_type": "POSITIONAL_TP_SL",
        "child_orders": [
          {
            "symbol": "PERP_ETH_USDC",
            "algo_type": "TAKE_PROFIT",
            "side": "SELL",
            "type": "CLOSE_POSITION",
            "trigger_price": 3518.4,
            "reduce_only": true
          },
          {
            "symbol": "PERP_ETH_USDC",
            "algo_type": "STOP_LOSS",
            "side": "SELL",
            "type": "CLOSE_POSITION",
            "trigger_price": 3313.4,
            "reduce_only": true
          }
        ]
      }
    ]
  },
  {
    "symbol": "PERP_NEAR_USDC",
    "algo_type": "TP_SL",
    "quantity": 5.5,
    "trigger_price_type": "MARK_PRICE",
    "child_orders": [
      {
        "symbol": "PERP_NEAR_USDC",
        "algo_type": "TAKE_PROFIT",
        "side": "SELL",
        "type": "MARKET",
        "trigger_price": 3.365,
        "reduce_only": true
      },
      {
        "symbol": "PERP_NEAR_USDC",
        "algo_type": "STOP_LOSS",
        "side": "SELL",
        "type": "MARKET",
        "trigger_price": 3.36,
        "reduce_only": true
      }
    ]
  },
  {
    "symbol": "PERP_NEAR_USDC",
    "algo_type": "POSITIONAL_TP_SL",
    "trigger_price_type": "MARK_PRICE",
    "child_orders": [
      {
        "symbol": "PERP_NEAR_USDC",
        "algo_type": "TAKE_PROFIT",
        "side": "SELL",
        "type": "CLOSE_POSITION",
        "trigger_price_type": "MARK_PRICE",
        "trigger_price": 4.05,
        "reduce_only": true
      },
      {
        "symbol": "PERP_NEAR_USDC",
        "algo_type": "STOP_LOSS",
        "side": "SELL",
        "type": "CLOSE_POSITION",
        "trigger_price_type": "MARK_PRICE",
        "trigger_price": 3.95,
        "reduce_only": true
      }
    ]
  }
]
'

200

{
  "success": true,
  "data": {
    "order_id": 13,
    "client_order_id": "testclientid",
    "algo_type": "STOP",
    "quantity": 100.12
  },
  "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.

x-recv-window · number

Use this parameter to control the timeout threshold for placing order, unit in miliseconds

Body

application/json

symbol · string · required

algo_type · string · required

STOP/TP_SL/POSITIONAL_TP_SL/BRACKET/BRACKET + TP_SL/TRAILING_STOP

type · string · required

LIMIT / MARKET, required if algo_type = STOP

quantity · number · required

For MARKET/ASK/BID order, if order_amount is given, it is not required. Not required if type is POSITIONAL_TP_SL.

side · string · required

SELL/BUY, required if STOP type

child_orders · object[] · required

Show child attributes

client_order_id · string

36 length, accepts hyphen but cannot be the first character, default: null

price · number

Optional for TP_SL and POSTIONAL_TP_SL

trigger_price_type · string

Only MARK_PRICE is available for now.

trigger_price · number

reduce_only · boolean

visible_quantity · boolean

Default false

order_tag · string

activatedPrice · string

Activated price for algoType=TRAILING_STOP

callbackRate · string

Callback rate, only for algoType=TRAILING_STOP, i.e. the value = 0.1 represent to 10%.

callbackValue · string

Callback value, only for algoType=TRAILING_STOP, i.e. the value = 100

margin_mode · enum<string>

Margin mode for the order. Default: the symbol's current default margin mode.

Available options: CROSS, ISOLATED

Response

200 - application/json

OK

success · boolean · required

Indicates whether the request was successful.

Example:

true

data · object · required

Show child attributes

timestamp · integer

Server timestamp in milliseconds.

Example:

1702989203989