Interface: AdvTradeGlobalOrder
Properties
| Property | Type | Description |
|---|---|---|
advanced? | AdvTradeGlobalAdvanced | advanced type: "usd" or "implv" (Only for options; field is omitted if not applicable). |
amount? | number | Order size. Use base-coin units for spot, options, and linear instruments, including linear perpetuals; use USD for inverse futures and inverse perpetuals. |
api | boolean | true if created with API |
app_name? | string | The name of the application that placed the order on behalf of the user (optional). |
auto_replaced? | boolean | Options, advanced orders only - true if last modification of the order was performed by the pricing engine, otherwise false. |
average_price? | number | Average fill price of the order |
block_trade? | boolean | true if order made from block_trade trade, added only in that case. |
cancel_reason? | string | 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 event, e.g. good-til-day orders are cancelled when an instrument enters the daily settlement). Note: orders cancelled because an instrument expired (delivery) currently do not include a cancel_reason field. |
combo_order_id? | string | Id of the combo order that created this order (only present for orders that were created as legs of a combo order). |
contracts? | number | It represents the order size in contract units. (Optional, may be absent in historical data). |
creation_timestamp | number | The timestamp (milliseconds since the Unix epoch) |
direction | AdvTradeGlobalDirection | Direction: buy, or sell |
display_amount? | number | The actual display amount of iceberg order. Absent for other types of orders. |
filled_amount? | number | Filled order size in the same amount units as the order. Use base-coin units for spot, options, and linear instruments, including linear perpetuals; use USD for inverse futures and inverse perpetuals. |
implv? | number | Implied volatility in percent. (Only if advanced="implv") |
instrument_name | string | Unique instrument identifier |
is_liquidation? | boolean | Optional (not added for spot). true if order was automatically created during liquidation |
is_primary_otoco? | boolean | true if the order is an order that can trigger an OCO pair, otherwise not present. |
is_rebalance? | boolean | Optional (only for spot). true if order was automatically created during cross-collateral balance restoration |
is_secondary_oto? | boolean | true if the order is an order that can be triggered by another order, otherwise not present. |
isolated? | boolean | Flag indicating whether the order belongs to an isolated margin subaccount. Present and true on isolated orders only. |
label | string | User defined label (up to 64 characters) |
last_update_timestamp | number | The timestamp (milliseconds since the Unix epoch) |
main_uid? | number | User identifier for the owning main account. Present on isolated orders only. |
mmp? | boolean | true if the order is a MMP order, otherwise false. |
mmp_cancelled? | boolean | true if order was cancelled by mmp trigger (optional) |
mmp_group? | string | Name of the MMP group supplied in the private/mass_quote request. Only present for quote orders. |
mobile? | boolean | Optional field with value true added only when created with Mobile Application |
oco_ref? | string | Unique reference that identifies a one_cancels_others (OCO) pair. |
order_id | string | Unique order identifier |
order_state | AdvTradeGlobalOrderState | Order state: "open", "filled", "rejected", "cancelled", "untriggered" |
order_type | AdvTradeGlobalOrderType | Order type: "limit", "market", "stop_limit", "stop_market", "take_limit", "take_market", "trailing_stop" |
original_order_type? | AdvTradeGlobalOriginalOrderType | Original API order type when an order is represented internally as a limit order. For example, Starbase market orders use "limit" as order_type with "market" in this optional field. |
oto_order_ids? | string[] | The Ids of the orders that will be triggered if the order is filled |
post_only | boolean | true for post-only orders only |
price | AdvTradeGlobalOpenOrderPrice | Order price in the instrument’s price units, or "market_price" for an open trigger market order. |
primary_order_id? | string | ID of the order that triggered this order. |
quote? | boolean | If order is a quote. Present only if true. |
quote_id? | string | The same QuoteID as supplied in the private/mass_quote request. Only present for quote orders. |
quote_set_id? | string | Identifier of the QuoteSet supplied in the private/mass_quote request. Only present for quote orders. |
reduce_only? | boolean | Optional (not added for spot). 'true for reduce-only orders only' |
refresh_amount? | 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 |
reject_post_only? | boolean | true if order has reject_post_only flag (field is present only when post_only is true) |
replaced? | boolean | true if the order was edited (by user or - in case of advanced options orders - by pricing engine), otherwise false. |
risk_reducing? | 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. |
starbase_client_order_id? | string | Client order id of an order submitted directly to Starbase via direct access; not returned for orders placed through the Deribit API (combo legs inherit the parent combo order's client order id) |
starbase_last_update_timestamp? | number | The Starbase causal timestamp (nanoseconds since the Unix epoch) of the last book update that affected this order. Present only for orders placed in Starbase, including combo leg order updates; not always available for direct access orders |
starbase_order_id? | number | Raw Starbase order id, in Starbase's own (non currency-prefixed) id namespace. Only present for orders placed in Starbase. Combo leg orders expose the parent combo order's Starbase order id. |
time_in_force | AdvTradeGlobalTimeInForce | Order time in force: "good_til_cancelled", "good_til_day", "fill_or_kill" or "immediate_or_cancel" |
trigger? | AdvTradeGlobalTrigger | Trigger type (only for trigger orders). Allowed values: "index_price", "mark_price", "last_price". |
trigger_fill_condition? | AdvTradeGlobalTriggerFillCondition | 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. |
trigger_offset? | number | The maximum deviation from the price peak beyond which the order will be triggered (Only for trailing trigger orders) |
trigger_order_id? | string | Id of the trigger order that created the order (Only for orders that were created by triggered orders). |
trigger_price? | number | Trigger price (Only for future trigger orders) |
trigger_reference_price? | number | The price of the given trigger at the time when the order was placed (Only for trailing trigger orders) |
triggered? | boolean | Whether the trigger order has been triggered |
usd? | number | Option price in USD (Only if advanced="usd") |
user_id? | number | User identifier for the account that owns the order. For isolated orders, this is the subaccount ID. |
web? | boolean | true if created via Deribit frontend (optional) |