Get Order History

post https://api.lyra.finance/private/get_order_history

Get order history for a subaccount
Required minimum session key permission level is read_only

Response

Response body

object

required

result

object

required

orders

array of objects

required

List of open orders

orders*

object

amount

string

required

Order amount in units of the base

average_price

string

required

Average fill price

cancel_reason

string

required

If cancelled, reason behind order cancellation

user_request mmp_trigger insufficient_margin signed_max_fee_too_low cancel_on_disconnect ioc_or_market_partial_fill session_key_deregistered subaccount_withdrawn compliance trigger_failed validation_failed

creation_timestamp

integer

required

Creation timestamp (in ms since Unix epoch)

direction

string

required

Order direction

buy sell

filled_amount

string

required

Total filled amount for the order

instrument_name

string

required

Instrument name

is_transfer

boolean

required

Whether the order was generated through private/transfer_position

label

string

required

Optional user-defined label for the order

last_update_timestamp

integer

required

Last update timestamp (in ms since Unix epoch)

limit_price

string

required

Limit price in quote currency

max_fee

string

required

Max fee in units of the quote currency

mmp

boolean

required

Whether the order is tagged for market maker protections

nonce

integer

required

Unique nonce defined as <UTC_timestamp in ms><random_number_up_to_3_digits> (e.g. 1695836058725001, where 001 is the random number)

order_fee

string

required

Total order fee paid so far

order_id

string

required

Order ID

order_status

string

required

Order status

open filled cancelled expired untriggered

order_type

string

required

Order type

limit market

quote_id

string | null

required

Defaults to null

Quote ID if the trade was executed via RFQ

replaced_order_id

string | null

Defaults to null

If replaced, ID of the order that was replaced

signature

string

required

Ethereum signature of the order

signature_expiry_sec

integer

required

Signature expiry timestamp

signer

string

required

Owner wallet address or registered session key that signed order

subaccount_id

integer

required

Subaccount ID

time_in_force

string

required

Time in force

gtc post_only fok ioc

trigger_price

string | null

Defaults to null

(Required for trigger orders) Index or Market price to trigger order at

trigger_price_type

string | null

Defaults to null

(Required for trigger orders) Trigger with Index or Mark Price

mark index

trigger_reject_message

string | null

Defaults to null

(Required for trigger orders) Error message if error occured during trigger

trigger_type

string | null

Defaults to null

(Required for trigger orders) Stop-loss or Take-profit.

stoploss takeprofit

pagination

object

required

subaccount_id

integer

required

Subaccount_id for which to get open orders

Language

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.lyra.finance/private/get_order_history \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "page": 1,
8
  "page_size": 100
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation