Skip to main content
POST
/
v1
/
algo
/
order
Create algo order
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
      }
    ]
  }
]
'
import requests

url = "https://api.orderly.org/v1/algo/order"

payload = [
{
"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
}
]
}
]
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([
{
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
}
]
}
])
};

fetch('https://api.orderly.org/v1/algo/order', 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/algo/order",
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([
[
'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
]
]
]
]),
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/algo/order"

payload := strings.NewReader("[\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"BRACKET\",\n \"quantity\": 0.0032,\n \"side\": \"BUY\",\n \"type\": \"LIMIT\",\n \"price\": 3415.9,\n \"child_orders\": [\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"POSITIONAL_TP_SL\",\n \"child_orders\": [\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"TAKE_PROFIT\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price\": 3518.4,\n \"reduce_only\": true\n },\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price\": 3313.4,\n \"reduce_only\": true\n }\n ]\n }\n ]\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"TP_SL\",\n \"quantity\": 5.5,\n \"trigger_price_type\": \"MARK_PRICE\",\n \"child_orders\": [\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"TAKE_PROFIT\",\n \"side\": \"SELL\",\n \"type\": \"MARKET\",\n \"trigger_price\": 3.365,\n \"reduce_only\": true\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"type\": \"MARKET\",\n \"trigger_price\": 3.36,\n \"reduce_only\": true\n }\n ]\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"POSITIONAL_TP_SL\",\n \"trigger_price_type\": \"MARK_PRICE\",\n \"child_orders\": [\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"TAKE_PROFIT\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price_type\": \"MARK_PRICE\",\n \"trigger_price\": 4.05,\n \"reduce_only\": true\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price_type\": \"MARK_PRICE\",\n \"trigger_price\": 3.95,\n \"reduce_only\": true\n }\n ]\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/algo/order")
.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 {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"BRACKET\",\n \"quantity\": 0.0032,\n \"side\": \"BUY\",\n \"type\": \"LIMIT\",\n \"price\": 3415.9,\n \"child_orders\": [\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"POSITIONAL_TP_SL\",\n \"child_orders\": [\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"TAKE_PROFIT\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price\": 3518.4,\n \"reduce_only\": true\n },\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price\": 3313.4,\n \"reduce_only\": true\n }\n ]\n }\n ]\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"TP_SL\",\n \"quantity\": 5.5,\n \"trigger_price_type\": \"MARK_PRICE\",\n \"child_orders\": [\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"TAKE_PROFIT\",\n \"side\": \"SELL\",\n \"type\": \"MARKET\",\n \"trigger_price\": 3.365,\n \"reduce_only\": true\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"type\": \"MARKET\",\n \"trigger_price\": 3.36,\n \"reduce_only\": true\n }\n ]\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"POSITIONAL_TP_SL\",\n \"trigger_price_type\": \"MARK_PRICE\",\n \"child_orders\": [\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"TAKE_PROFIT\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price_type\": \"MARK_PRICE\",\n \"trigger_price\": 4.05,\n \"reduce_only\": true\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price_type\": \"MARK_PRICE\",\n \"trigger_price\": 3.95,\n \"reduce_only\": true\n }\n ]\n }\n]")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/algo/order")

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 {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"BRACKET\",\n \"quantity\": 0.0032,\n \"side\": \"BUY\",\n \"type\": \"LIMIT\",\n \"price\": 3415.9,\n \"child_orders\": [\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"POSITIONAL_TP_SL\",\n \"child_orders\": [\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"TAKE_PROFIT\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price\": 3518.4,\n \"reduce_only\": true\n },\n {\n \"symbol\": \"PERP_ETH_USDC\",\n \"algo_type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price\": 3313.4,\n \"reduce_only\": true\n }\n ]\n }\n ]\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"TP_SL\",\n \"quantity\": 5.5,\n \"trigger_price_type\": \"MARK_PRICE\",\n \"child_orders\": [\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"TAKE_PROFIT\",\n \"side\": \"SELL\",\n \"type\": \"MARKET\",\n \"trigger_price\": 3.365,\n \"reduce_only\": true\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"type\": \"MARKET\",\n \"trigger_price\": 3.36,\n \"reduce_only\": true\n }\n ]\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"POSITIONAL_TP_SL\",\n \"trigger_price_type\": \"MARK_PRICE\",\n \"child_orders\": [\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"TAKE_PROFIT\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price_type\": \"MARK_PRICE\",\n \"trigger_price\": 4.05,\n \"reduce_only\": true\n },\n {\n \"symbol\": \"PERP_NEAR_USDC\",\n \"algo_type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"type\": \"CLOSE_POSITION\",\n \"trigger_price_type\": \"MARK_PRICE\",\n \"trigger_price\": 3.95,\n \"reduce_only\": true\n }\n ]\n }\n]"

response = http.request(request)
puts response.read_body
{
  "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
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

Optional tag for the order. Supports two formats:

  • Referral code: plain string (e.g., REFERRAL2026) - overrides referral relationship
  • Order tag fee config: enum:<enum_id> (e.g., enum:STRATEGY_DCA) - adds fee on top of existing fees, preserves referral Max length: 36 characters. Cannot be modified after order placement.
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
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989