Skip to main content
Messages
kind
type:enum
required

Instrument kind

Allowed values: future, option, spot, future_combo, option_combo

Available options: future, option, spot, future_combo, option_combo
currency
type:enum
required

Currency code or any for all

Allowed values: BTC, ETH, USDC, USDT, EURR, any

Available options: BTC, ETH, USDC, USDT, EURR, any
interval
type:enum
required

Frequency of notifications. Events will be aggregated over this interval. The value raw means no aggregation will be applied (Please note that raw interval is only available to authorized users)

Allowed values: raw, 100ms, agg2

Available options: raw, 100ms, agg2
Subscription Request
type:object

Client sends subscription request to subscribe to notification channel. Please refer to Notification page for more information.

Subscription Notification Data
type:object

Server sends subscription notification data

data
type:object
required
order_id
type:string
required

Unique order identifier

order_state
type:enum
required

Order state: "open", "filled", "rejected", "cancelled", "untriggered"

Available options: open, filled, rejected, cancelled, untriggered, triggered
order_type
type:enum
required

Order type: "limit", "market", "stop_limit", "stop_market", "take_limit", "take_market", "trailing_stop"

Available options: market, limit, stop_market, stop_limit, take_market, take_limit, trailing_stop
original_order_type
type:enum

Original order type. Optional field

Available options: market, market_limit
time_in_force
type:enum
required

Order time in force: "good_til_cancelled", "good_til_day", "fill_or_kill" or "immediate_or_cancel"

Available options: good_til_cancelled, good_til_day, fill_or_kill, immediate_or_cancel
is_rebalance
type:boolean

Optional (only for spot). true if order was automatically created during cross-collateral balance restoration

is_liquidation
type:boolean

Optional (not added for spot). true if order was automatically created during liquidation

instrument_name
type:string
required

Unique instrument identifier

creation_timestamp
type:integer
required

The timestamp (milliseconds since the Unix epoch)

last_update_timestamp
type:integer
required

The timestamp (milliseconds since the Unix epoch)

direction
type:enum
required

Direction: buy, or sell

Available options: buy, sell
description
type:string

Price in base currency or "market_price" in case of open trigger market orders

label
type:string
required

User defined label (up to 64 characters)

post_only
type:boolean
required

true for post-only orders only

reject_post_only
type:boolean

true if order has reject_post_only flag (field is present only when post_only is true)

reduce_only
type:boolean

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

api
type:boolean
required

true if created with API

web
type:boolean

true if created via Deribit frontend (optional)

mobile
type:boolean

Optional field with value true added only when created with Mobile Application

refresh_amount
type:number

The initial display amount of iceberg order. Iceberg order display amount will be refreshed to that value after match consuming actual display amount. Absent for other types of orders

display_amount
type:number

The actual display amount of iceberg order. Absent for other types of orders.

amount
type:number

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.

contracts
type:number

It represents the order size in contract units. (Optional, may be absent in historical data).

filled_amount
type:number

Filled amount of the order. For perpetual and futures the filled_amount is in USD units, for options - in units or corresponding cryptocurrency contracts, e.g., BTC or ETH.

average_price
type:number

Average fill price of the order

advanced
type:enum

advanced type: "usd" or "implv" (Only for options; field is omitted if not applicable).

Available options: usd, implv
implv
type:number

Implied volatility in percent. (Only if advanced="implv")

usd
type:number

Option price in USD (Only if advanced="usd")

triggered
type:boolean

Whether the trigger order has been triggered

trigger
type:enum

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

Available options: index_price, mark_price, last_price
trigger_price
type:number

Trigger price (Only for future trigger orders)

trigger_offset
type:number

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

trigger_reference_price
type:number

The price of the given trigger at the time when the order was placed (Only for trailing trigger orders)

block_trade
type:boolean

true if order made from block_trade trade, added only in that case.

mmp
type:boolean

true if the order is a MMP order, otherwise false.

risk_reducing
type:boolean

true if the order is marked by the platform as a risk reducing order (can apply only to orders placed by PM users), otherwise false.

replaced
type:boolean

true if the order was edited (by user or - in case of advanced options orders - by pricing engine), otherwise false.

auto_replaced
type:boolean

Options, advanced orders only - true if last modification of the order was performed by the pricing engine, otherwise false.

quote
type:boolean

If order is a quote. Present only if true.

mmp_group
type:string

Name of the MMP group supplied in the private/mass_quote request. Only present for quote orders.

quote_set_id
type:string

Identifier of the QuoteSet supplied in the private/mass_quote request. Only present for quote orders.

quote_id
type:string

The same QuoteID as supplied in the private/mass_quote request. Only present for quote orders.

trigger_order_id
type:string

Id of the trigger order that created the order (Only for orders that were created by triggered orders).

combo_order_id
type:string

Id of the combo order that created this order (only present for orders that were created as legs of a combo order).

app_name
type:string

The name of the application that placed the order on behalf of the user (optional).

mmp_cancelled
type:boolean

true if order was cancelled by mmp trigger (optional)

cancel_reason
type:enum

Enumerated reason behind cancel "user_request", "autoliquidation", "cancel_on_disconnect", "risk_mitigation", "pme_risk_reduction" (portfolio margining risk reduction), "pme_account_locked" (portfolio margining account locked per currency), "position_locked", "mmp_trigger" (market maker protection), "mmp_config_curtailment" (market maker configured quantity decreased), "edit_post_only_reject" (cancelled on edit because of reject_post_only setting), "oco_other_closed" (the oco order linked to this order was closed), "oto_primary_closed" (the oto primary order that was going to trigger this order was cancelled), "settlement" (closed because of a settlement)

Available options: user_request, autoliquidation, cancel_on_disconnect, risk_mitigation, pme_risk_reduction, pme_account_locked, position_locked, mmp_trigger, mmp_config_curtailment, edit_post_only_reject, oco_other_closed, oto_primary_closed, settlement
oto_order_ids
type:object

The Ids of the orders that will be triggered if the order is filled

trigger_fill_condition
type:enum

The fill condition of the linked order (Only for linked order types), default: `first_hit`.

  • `"first_hit"` - any execution of the primary order will fully cancel/place all secondary orders.
  • `"complete_fill"` - a complete execution (meaning the primary order no longer exists) will cancel/place the secondary orders.
  • `"incremental"` - any fill of the primary order will cause proportional partial cancellation/placement of the secondary order. The amount that will be subtracted/added to the secondary order will be rounded down to the contract size.
Available options: first_hit, complete_fill, incremental
oco_ref
type:string

Unique reference that identifies a one_cancels_others (OCO) pair.

primary_order_id
type:string

Unique order identifier

is_secondary_oto
type:boolean

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

is_primary_otoco
type:boolean

true if the order is an order that can trigger an OCO pair, otherwise not present.