Skip to main content
GET
/
v1
/
client
/
aggregate
/
positions
Get aggregate positions
curl --request GET \
  --url https://api.orderly.org/v1/client/aggregate/positions \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
import requests

url = "https://api.orderly.org/v1/client/aggregate/positions"

headers = {
"orderly-timestamp": "<orderly-timestamp>",
"orderly-account-id": "<orderly-account-id>",
"orderly-key": "<orderly-key>",
"orderly-signature": "<orderly-signature>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {
'orderly-timestamp': '<orderly-timestamp>',
'orderly-account-id': '<orderly-account-id>',
'orderly-key': '<orderly-key>',
'orderly-signature': '<orderly-signature>'
}
};

fetch('https://api.orderly.org/v1/client/aggregate/positions', 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/client/aggregate/positions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

url := "https://api.orderly.org/v1/client/aggregate/positions"

req, _ := http.NewRequest("GET", url, nil)

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>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.orderly.org/v1/client/aggregate/positions")
.header("orderly-timestamp", "<orderly-timestamp>")
.header("orderly-account-id", "<orderly-account-id>")
.header("orderly-key", "<orderly-key>")
.header("orderly-signature", "<orderly-signature>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/client/aggregate/positions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "timestamp": 1702989203989,
  "data": [
    {
      "account_id": "0x11111",
      "IMR_withdraw_orders": 0.1,
      "MMR_with_orders": 0.05,
      "average_open_price": 27908.14386047,
      "cost_position": -139329.358492,
      "est_liq_price": 117335.92899428,
      "fee_24_h": 0,
      "imr": 0.1,
      "last_sum_unitary_funding": 70.38,
      "mark_price": 27794.9,
      "mmr": 0.05,
      "pending_long_qty": 0,
      "pending_short_qty": 0,
      "pnl_24_h": 0,
      "position_qty": -5,
      "settle_price": 27865.8716984,
      "symbol": "PERP_BTC_USDC",
      "seq": 1730181536341943600,
      "timestamp": 1685429350571,
      "updated_time": 1685429350571,
      "unsettled_pnl": 354.858492,
      "leverage": 10
    },
    {
      "account_id": "0x22222",
      "IMR_withdraw_orders": 0.12,
      "MMR_with_orders": 0.06,
      "average_open_price": 28000.123456,
      "cost_position": -100000.56789,
      "est_liq_price": 120000.654321,
      "fee_24_h": 5.5,
      "imr": 0.12,
      "last_sum_unitary_funding": 50.12,
      "mark_price": 27794.9,
      "mmr": 0.06,
      "pending_long_qty": 1,
      "pending_short_qty": 0,
      "pnl_24_h": 150.75,
      "position_qty": -3,
      "settle_price": 27950.6789,
      "symbol": "PERP_BTC_USDC",
      "seq": 1730181536341943600,
      "timestamp": 1685429350572,
      "updated_time": 1685429350571,
      "unsettled_pnl": 354.858492,
      "leverage": 10
    }
  ]
}

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.

Response

200 - application/json

OK

success
boolean
required

Indicates whether the request was successful.

Example:

true

timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989

data
object
Example:
[
{
"account_id": "0x11111",
"IMR_withdraw_orders": 0.1,
"MMR_with_orders": 0.05,
"average_open_price": 27908.14386047,
"cost_position": -139329.358492,
"est_liq_price": 117335.92899428,
"fee_24_h": 0,
"imr": 0.1,
"last_sum_unitary_funding": 70.38,
"mark_price": 27794.9,
"mmr": 0.05,
"pending_long_qty": 0,
"pending_short_qty": 0,
"pnl_24_h": 0,
"position_qty": -5,
"settle_price": 27865.8716984,
"symbol": "PERP_BTC_USDC",
"seq": 1730181536341943600,
"timestamp": 1685429350571,
"updated_time": 1685429350571,
"unsettled_pnl": 354.858492,
"leverage": 10
},
{
"account_id": "0x22222",
"IMR_withdraw_orders": 0.12,
"MMR_with_orders": 0.06,
"average_open_price": 28000.123456,
"cost_position": -100000.56789,
"est_liq_price": 120000.654321,
"fee_24_h": 5.5,
"imr": 0.12,
"last_sum_unitary_funding": 50.12,
"mark_price": 27794.9,
"mmr": 0.06,
"pending_long_qty": 1,
"pending_short_qty": 0,
"pnl_24_h": 150.75,
"position_qty": -3,
"settle_price": 27950.6789,
"symbol": "PERP_BTC_USDC",
"seq": 1730181536341943600,
"timestamp": 1685429350572,
"updated_time": 1685429350571,
"unsettled_pnl": 354.858492,
"leverage": 10
}
]