Skip to main content
GET
/
v1
/
admin
/
algo
/
orders
Get algo orders (admin)
curl --request GET \
  --url https://api.orderly.org/v1/admin/algo/orders \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
{
  "success": true,
  "data": {
    "meta": {
      "total": 9,
      "records_per_page": 25,
      "current_page": 1
    },
    "rows": [
      {
        "algo_order_id": 168400010,
        "user_id": 12345,
        "algo_status": "NEW",
        "algo_type": "STOP",
        "fee_asset": "USDC",
        "is_triggered": "false",
        "order_tag": "test_tag",
        "parent_algo_order_id": 0,
        "quantity": 5.5,
        "root_algo_order_id": 168400010,
        "root_algo_order_status": "NEW",
        "side": "BUY",
        "symbol": "PERP_NEAR_USDC",
        "margin_mode": "CROSS",
        "executed_quantity": 0,
        "total_executed_quantity": 0,
        "total_fee": 0,
        "trigger_price": 2.5,
        "trigger_price_type": "MARK_PRICE",
        "type": "MARKET",
        "created_time": 1702871974317,
        "updated_time": 1702871974317,
        "visible_quantity": 5.5,
        "realized_pnl": 0,
        "child_orders": [
          {}
        ]
      }
    ]
  },
  "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.

Query Parameters

​
symbol
string
​
order_type
string

LIMIT/MARKET

​
status
string

NEW/CANCELLED/PARTIAL_FILLED/FILLED/REJECTED/INCOMPLETE/COMPLETED

​
order_tag
string

Filter by a custom tag assigned to the order.

​
start_t
number

start time range that wish to query, noted the time stamp is 13-digits timestamp.

​
end_t
number

end time range that wish to query, noted the time stamp is 13-digits timestamp.

​
page
number

the page you wish to query. start from 1

​
size
number

the page size you wish to query (max: 500)

​
side
string

BUY/SELL

​
algo_type
string

Supported types are STOP, TPSL, positional_TPSL

​
is_triggered
string
​
user_account
string

Target user account to query for admin usage, required for either user_account or user_address

​
user_address
string

Target user address to query for admin usage, required for either user_account or user_address

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