Skip to main content
GET
Get orders

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

Filter results to a specific trading symbol, for example PERP_ETH_USDC.

side
string

BUY/SELL

order_type
enum<string>

LIMIT/MARKET/IOC/POST_ONLY/FOK/ASK/BID

Available options:
LIMIT,
MARKET,
IOC,
POST_ONLY,
FOK,
ASK,
BID
status
string

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

order_tag
string

Filter by the full stored order tag, including a current-format enum:<owning_broker_id>:<enum_id> tag.

Maximum string length: 128
start_t
number

Start of the query range as a 13-digit Unix timestamp in milliseconds. Required in broker mode and optional in per-user mode. The broker-mode range cannot exceed 180 days.

end_t
number

End of the query range as a 13-digit Unix timestamp in milliseconds. Required in broker mode and optional in per-user mode. The broker-mode range cannot exceed 180 days.

update_start_t
number

Filter orders updated at or after this 13-digit Unix timestamp in milliseconds.

update_end_t
number

Filter orders updated at or before this 13-digit Unix timestamp in milliseconds.

source_type
enum<string>

Filter orders by source type: ORDINARY or ALL.

Available options:
ORDINARY,
ALL
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;

user_account
string

Target user account for per-user mode. Provide either user_account or user_address. Omit both to use broker mode, which requires start_t and end_t.

user_address
string

Target user address for per-user mode. Provide either user_address or user_account. Omit both to use broker mode, which requires start_t and end_t.

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