private/get_trigger_order_history

Retrieves a detailed log of all trigger orders (stop orders, take-profit orders, etc.) for the authenticated account. The log includes trigger order creation, activation, execution, and cancellation events.

Results can be filtered by currency and instrument name. Use pagination parameters (count and continuation) to retrieve large trigger order histories. This is useful for tracking trigger order activity and debugging trigger order behavior.

Scope: trade:read

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_trigger_order_history \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 2552,
  "method": "private/get_trigger_order_history",
  "params": {
    "currency": "ETH",
    "count": 10
  }
}
'

200

{
  "jsonrpc": "2.0",
  "id": 2192,
  "result": {
    "entries": [
      {
        "trigger": "index",
        "timestamp": 1555918941451,
        "trigger_price": 5285,
        "trigger_order_id": "SLIS-103",
        "order_state": "new",
        "request": "trigger:order",
        "price": 5179.28,
        "order_id": "671473",
        "offset": 277,
        "instrument_name": "BTC-PERPETUAL",
        "amount": 10,
        "direction": "buy"
      }
    ],
    "continuation": "1555918941451.SLIS-103"
  }
}

Query Parameters

currency · enum<string> · required

The currency symbol Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR

instrument_name · string

Instrument name Unique instrument identifier

Example:

"BTC-PERPETUAL"

count · integer

Number of requested items, default - 20, maximum - 1000

Required range: 1 <= x <= 1000

continuation · string

Continuation token for pagination

Example:

"xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT"

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. entries · object[]

Hide child attributes

result.entries. timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.entries. trigger · enum<string> · required

Trigger type (only for trigger orders). Allowed values: "index_price", "mark_price", "last_price".

Available options: index_price, mark_price, last_price

result.entries. trigger_price · number · required

Trigger price (Only for future trigger orders)

result.entries. trigger_offset · number · required

The maximum deviation from the price peak beyond which the order will be triggered (Only for trailing trigger orders)

result.entries. trigger_order_id · string · required

Id of the user order used for the trigger-order reference before triggering

Example:

"SLTB-187015"

result.entries. order_id · string · required

Unique order identifier

Example:

"ETH-100234"

result.entries. order_state · string · required

Order state: "triggered", "cancelled", or "rejected" with rejection reason (e.g. "rejected:reduce_direction").

result.entries. instrument_name · string · required

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result.entries. request · string · required

Type of last request performed on the trigger order by user or system. "cancel" - when order was cancelled, "trigger:order" - when trigger order spawned market or limit order after being triggered

Example:

"trigger:order"

result.entries. direction · enum<string> · required

Direction: buy, or sell

Available options: buy, sell

result.entries. price · number · required

Price in base currency

result.entries. amount · number · required

It represents the requested order size. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

result.entries. reduce_only · boolean · required

Optional (not added for spot). 'true for reduce-only orders only'

result.entries. post_only · boolean · required

true for post-only orders only

result.entries. order_type · enum<string> · required

Requested order type: "limit or "market"

Available options: limit, market

result.entries. last_update_timestamp · integer

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.entries. label · string

User defined label (presented only when previously set for order by user)

result.entries. is_secondary_oto · boolean

true if the order is an order that can be triggered by another order, otherwise not present.

result.entries. oco_ref · string

Unique reference that identifies a one_cancels_others (OCO) pair.

result.entries. source · string

Source of the order that is linked to the trigger order.

Example:

"api"

result. continuation · string

Continuation token for pagination.

Example:

"xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT"

id · integer

The id that was sent in the request