Edit order
curl --request PUT \
--url https://api.orderly.org/v1/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>",
"symbol": "<string>",
"order_type": "<string>",
"side": "<string>",
"client_order_id": "<string>",
"order_price": 123,
"order_quantity": 123,
"order_amount": 123,
"reduce_only": true,
"visible_quantity": 123,
"order_tag": "<string>"
}
'import requests
url = "https://api.orderly.org/v1/order"
payload = {
"order_id": "<string>",
"symbol": "<string>",
"order_type": "<string>",
"side": "<string>",
"client_order_id": "<string>",
"order_price": 123,
"order_quantity": 123,
"order_amount": 123,
"reduce_only": True,
"visible_quantity": 123,
"order_tag": "<string>"
}
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>',
symbol: '<string>',
order_type: '<string>',
side: '<string>',
client_order_id: '<string>',
order_price: 123,
order_quantity: 123,
order_amount: 123,
reduce_only: true,
visible_quantity: 123,
order_tag: '<string>'
})
};
fetch('https://api.orderly.org/v1/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/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>',
'symbol' => '<string>',
'order_type' => '<string>',
'side' => '<string>',
'client_order_id' => '<string>',
'order_price' => 123,
'order_quantity' => 123,
'order_amount' => 123,
'reduce_only' => true,
'visible_quantity' => 123,
'order_tag' => '<string>'
]),
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/order"
payload := strings.NewReader("{\n \"order_id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"order_type\": \"<string>\",\n \"side\": \"<string>\",\n \"client_order_id\": \"<string>\",\n \"order_price\": 123,\n \"order_quantity\": 123,\n \"order_amount\": 123,\n \"reduce_only\": true,\n \"visible_quantity\": 123,\n \"order_tag\": \"<string>\"\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/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 \"symbol\": \"<string>\",\n \"order_type\": \"<string>\",\n \"side\": \"<string>\",\n \"client_order_id\": \"<string>\",\n \"order_price\": 123,\n \"order_quantity\": 123,\n \"order_amount\": 123,\n \"reduce_only\": true,\n \"visible_quantity\": 123,\n \"order_tag\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orderly.org/v1/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 \"symbol\": \"<string>\",\n \"order_type\": \"<string>\",\n \"side\": \"<string>\",\n \"client_order_id\": \"<string>\",\n \"order_price\": 123,\n \"order_quantity\": 123,\n \"order_amount\": 123,\n \"reduce_only\": true,\n \"visible_quantity\": 123,\n \"order_tag\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "EDIT_SENT"
},
"timestamp": 1702989203989
}Order management
Edit order
Limit: 10 request per 1 second
PUT /v1/order
Edit a pending order by order_id. Only the order_price or order_quantity can be amended.
Note: This endpoint requires trading scope in orderly key.
PUT
/
v1
/
order
Edit order
curl --request PUT \
--url https://api.orderly.org/v1/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>",
"symbol": "<string>",
"order_type": "<string>",
"side": "<string>",
"client_order_id": "<string>",
"order_price": 123,
"order_quantity": 123,
"order_amount": 123,
"reduce_only": true,
"visible_quantity": 123,
"order_tag": "<string>"
}
'import requests
url = "https://api.orderly.org/v1/order"
payload = {
"order_id": "<string>",
"symbol": "<string>",
"order_type": "<string>",
"side": "<string>",
"client_order_id": "<string>",
"order_price": 123,
"order_quantity": 123,
"order_amount": 123,
"reduce_only": True,
"visible_quantity": 123,
"order_tag": "<string>"
}
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>',
symbol: '<string>',
order_type: '<string>',
side: '<string>',
client_order_id: '<string>',
order_price: 123,
order_quantity: 123,
order_amount: 123,
reduce_only: true,
visible_quantity: 123,
order_tag: '<string>'
})
};
fetch('https://api.orderly.org/v1/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/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>',
'symbol' => '<string>',
'order_type' => '<string>',
'side' => '<string>',
'client_order_id' => '<string>',
'order_price' => 123,
'order_quantity' => 123,
'order_amount' => 123,
'reduce_only' => true,
'visible_quantity' => 123,
'order_tag' => '<string>'
]),
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/order"
payload := strings.NewReader("{\n \"order_id\": \"<string>\",\n \"symbol\": \"<string>\",\n \"order_type\": \"<string>\",\n \"side\": \"<string>\",\n \"client_order_id\": \"<string>\",\n \"order_price\": 123,\n \"order_quantity\": 123,\n \"order_amount\": 123,\n \"reduce_only\": true,\n \"visible_quantity\": 123,\n \"order_tag\": \"<string>\"\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/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 \"symbol\": \"<string>\",\n \"order_type\": \"<string>\",\n \"side\": \"<string>\",\n \"client_order_id\": \"<string>\",\n \"order_price\": 123,\n \"order_quantity\": 123,\n \"order_amount\": 123,\n \"reduce_only\": true,\n \"visible_quantity\": 123,\n \"order_tag\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orderly.org/v1/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 \"symbol\": \"<string>\",\n \"order_type\": \"<string>\",\n \"side\": \"<string>\",\n \"client_order_id\": \"<string>\",\n \"order_price\": 123,\n \"order_quantity\": 123,\n \"order_amount\": 123,\n \"reduce_only\": true,\n \"visible_quantity\": 123,\n \"order_tag\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"status": "EDIT_SENT"
},
"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.
Body
application/json
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.
⌘I