Skip to main content
GET
/
v1
/
orders
Get orders
curl --request GET \
  --url https://api.orderly.org/v1/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": [
      {
        "order_id": 78151,
        "user_id": 12345,
        "price": 0.67772,
        "type": "LIMIT",
        "quantity": 20,
        "amount": 10,
        "total_executed_quantity": 20,
        "visible_quantity": 1,
        "symbol": "PERP_WOO_USDC",
        "side": "BUY",
        "status": "FILLED",
        "total_fee": 0.5,
        "fee_asset": "WOO",
        "client_order_id": 1,
        "average_executed_price": 0.67772,
        "created_time": 1653563963000,
        "updated_time": 1653564213000,
        "realized_pnl": 0,
        "executed_quantity": 20,
        "visible": 1,
        "executed": 20,
        "reduce_only": null,
        "order_tag": null,
        "margin_mode": "CROSS"
      }
    ]
  },
  "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
​
side
string

BUY/SELL

​
order_type
string

LIMIT/MARKET

​
status
string

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

​
order_tag
string
​
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)

​
sort_by
string

If empty:

Descending order by updated_time if user passed update_start_t or update_end_t; descending order by order_id if updated_time are the same;

Otherwise descending order by created_time; descending order by order_id if created_time are the same;

If not empty:

If sort_by == CREATED_TIME_DESC, descending order by created_time. Descending order by order_id if created_time are same;

If sort_by == CREATED_TIME_ASC, ascending order by created_time. Ascending order by order_id if created_time are same;

If sort_by == UPDATED_TIME_DESC, descending order by updated_time. Descending order by order_id if updated_time are same;

If sort_by == UPDATED_TIME_ASC, ascending order by updated_time. Ascending order by order_id if updated_time are same;

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