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
}Order management
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 --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
Timestamp of the signed request in milliseconds.
Account ID of the authenticated account.
Public orderly key used to sign the request.
Signature of the request payload generated with the orderly key.
Use this parameter to control the timeout threshold for placing order, unit in miliseconds
Body
application/json
STOP/TP_SL/POSITIONAL_TP_SL/BRACKET/BRACKET + TP_SL/TRAILING_STOP
LIMIT / MARKET, required if algo_type = STOP
For MARKET/ASK/BID order, if order_amount is given, it is not required. Not required if type is POSITIONAL_TP_SL.
SELL/BUY, required if STOP type
Show child attributes
Show child attributes
36 length, accepts hyphen but cannot be the first character, default: null
Optional for TP_SL and POSTIONAL_TP_SL
Only MARK_PRICE is available for now.
Default false
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.
Activated price for algoType=TRAILING_STOP
Callback rate, only for algoType=TRAILING_STOP, i.e. the value = 0.1 represent to 10%.
Callback value, only for algoType=TRAILING_STOP, i.e. the value = 100
Margin mode for the order. Default: the symbol's current default margin mode.
Available options:
CROSS, ISOLATED ⌘I