Skip to main content
PUT
/
v1
/
algo
/
order
Edit algo order
curl --request PUT \
  --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 '
{
  "order_id": "<string>",
  "price": 123,
  "quantity": 123,
  "trigger_price": 123,
  "trigger_price_type": "<string>",
  "child_orders": [
    {
      "order_id": "<string>",
      "trigger_price": 123,
      "price": 123,
      "quantity": 123,
      "is_activated": "<string>",
      "trigger_price_type": "<string>",
      "child_orders": [
        {}
      ]
    }
  ]
}
'
import requests

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

payload = {
"order_id": "<string>",
"price": 123,
"quantity": 123,
"trigger_price": 123,
"trigger_price_type": "<string>",
"child_orders": [
{
"order_id": "<string>",
"trigger_price": 123,
"price": 123,
"quantity": 123,
"is_activated": "<string>",
"trigger_price_type": "<string>",
"child_orders": [{}]
}
]
}
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.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
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({
order_id: '<string>',
price: 123,
quantity: 123,
trigger_price: 123,
trigger_price_type: '<string>',
child_orders: [
{
order_id: '<string>',
trigger_price: 123,
price: 123,
quantity: 123,
is_activated: '<string>',
trigger_price_type: '<string>',
child_orders: [{}]
}
]
})
};

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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'order_id' => '<string>',
'price' => 123,
'quantity' => 123,
'trigger_price' => 123,
'trigger_price_type' => '<string>',
'child_orders' => [
[
'order_id' => '<string>',
'trigger_price' => 123,
'price' => 123,
'quantity' => 123,
'is_activated' => '<string>',
'trigger_price_type' => '<string>',
'child_orders' => [
[

]
]
]
]
]),
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 \"order_id\": \"<string>\",\n \"price\": 123,\n \"quantity\": 123,\n \"trigger_price\": 123,\n \"trigger_price_type\": \"<string>\",\n \"child_orders\": [\n {\n \"order_id\": \"<string>\",\n \"trigger_price\": 123,\n \"price\": 123,\n \"quantity\": 123,\n \"is_activated\": \"<string>\",\n \"trigger_price_type\": \"<string>\",\n \"child_orders\": [\n {}\n ]\n }\n ]\n}")

req, _ := http.NewRequest("PUT", 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.put("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 \"order_id\": \"<string>\",\n \"price\": 123,\n \"quantity\": 123,\n \"trigger_price\": 123,\n \"trigger_price_type\": \"<string>\",\n \"child_orders\": [\n {\n \"order_id\": \"<string>\",\n \"trigger_price\": 123,\n \"price\": 123,\n \"quantity\": 123,\n \"is_activated\": \"<string>\",\n \"trigger_price_type\": \"<string>\",\n \"child_orders\": [\n {}\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::Put.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 \"order_id\": \"<string>\",\n \"price\": 123,\n \"quantity\": 123,\n \"trigger_price\": 123,\n \"trigger_price_type\": \"<string>\",\n \"child_orders\": [\n {\n \"order_id\": \"<string>\",\n \"trigger_price\": 123,\n \"price\": 123,\n \"quantity\": 123,\n \"is_activated\": \"<string>\",\n \"trigger_price_type\": \"<string>\",\n \"child_orders\": [\n {}\n ]\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "status": "EDIT_SENT"
  },
  "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
order_id
string
required
price
number
quantity
number
trigger_price
number
trigger_price_type
string
child_orders
object[]

Array of EditAlgoOrderChildRequest

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