Skip to content

Interface: AdvTradeGlobalWSUserTrade ​

WS examples use booleans and null here, despite string fields in the shared schema.

Extends ​

Properties ​

PropertyTypeDescriptionInherited from
advanced?"usd" | "implv"Advanced type of user order: "usd" or "implv" (only for options; omitted if not applicable)AdvTradeGlobalUserTrade.advanced
amountnumberTrade size. Use base-coin units for spot, options, and linear instruments, including linear perpetuals; use USD for inverse futures and inverse perpetuals.AdvTradeGlobalUserTrade.amount
api?booleantrue if user order was created with APIAdvTradeGlobalUserTrade.api
block_rfq_id?numberID of the Block RFQ - when trade was part of the Block RFQAdvTradeGlobalUserTrade.block_rfq_id
block_rfq_quote_id?numberID of the Block RFQ quote - when trade was part of the Block RFQAdvTradeGlobalUserTrade.block_rfq_quote_id
block_trade_id?stringBlock trade id - when trade was part of a block tradeAdvTradeGlobalUserTrade.block_trade_id
block_trade_leg_count?numberBlock trade leg count - when trade was part of a block tradeAdvTradeGlobalUserTrade.block_trade_leg_count
combo_id?stringOptional field containing combo instrument name if the trade is a combo tradeAdvTradeGlobalUserTrade.combo_id
combo_trade_id?stringOptional field containing combo trade identifier if the trade is a combo tradeAdvTradeGlobalUserTrade.combo_trade_id
contracts?numberTrade size in contract units (optional, may be absent in historical trades)AdvTradeGlobalUserTrade.contracts
directionAdvTradeGlobalDirectionTrade direction of the takerAdvTradeGlobalUserTrade.direction
feenumberUser's fee in units of the specified fee_currencyAdvTradeGlobalUserTrade.fee
fee_currencystringCurrency, i.e "BTC", "ETH", "USDC"AdvTradeGlobalUserTrade.fee_currency
index_pricenumberIndex Price at the moment of tradeAdvTradeGlobalUserTrade.index_price
instrument_namestringUnique instrument identifierAdvTradeGlobalUserTrade.instrument_name
isolated?booleanFlag indicating whether the trade belongs to an isolated margin subaccount. Present and true on isolated trades only.AdvTradeGlobalUserTrade.isolated
iv?numberOption implied volatility for the price (Option only)AdvTradeGlobalUserTrade.iv
label?stringUser defined label (presented only when previously set for order by user)AdvTradeGlobalUserTrade.label
legs?AdvTradeGlobalWSUserTrade[]--
liquidation?"M" | "T" | "MT"Optional field (only for trades caused by liquidation): "M" when maker side of trade was under liquidation, "T" when taker side was under liquidation, "MT" when both sides of trade were under liquidationAdvTradeGlobalUserTrade.liquidation
liquidity?"M" | "T"Describes what was role of users order: "M" when it was maker order, "T" when it was taker orderAdvTradeGlobalUserTrade.liquidity
main_uid?numberUser identifier for the owning main account. Present on isolated trades only.AdvTradeGlobalUserTrade.main_uid
mark_pricenumberMark Price at the moment of tradeAdvTradeGlobalUserTrade.mark_price
matching_idstring | null--
mmp?booleantrue if user order is MMPAdvTradeGlobalUserTrade.mmp
order_idstringId of the user order (maker or taker), i.e. subscriber's order id that took part in the tradeAdvTradeGlobalUserTrade.order_id
order_type?"limit" | "market" | "liquidation"Order type: "limit", "market", or "liquidation"AdvTradeGlobalUserTrade.order_type
original_order_type?AdvTradeGlobalOriginalOrderTypeOriginal 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.AdvTradeGlobalUserTrade.original_order_type
post_only?boolean--
pricenumberThe price of the tradeAdvTradeGlobalUserTrade.price
profit_loss?numberProfit and loss in base currency.AdvTradeGlobalUserTrade.profit_loss
quote_id?stringQuoteID of the user order (optional, present only for orders placed with private/mass_quote)AdvTradeGlobalUserTrade.quote_id
quote_set_id?stringQuoteSet of the user order (optional, present only for orders placed with private/mass_quote)AdvTradeGlobalUserTrade.quote_set_id
reduce_only?boolean--
risk_reducing?booleantrue if user order is marked by the platform as a risk reducing order (can apply only to orders placed by PM users)AdvTradeGlobalUserTrade.risk_reducing
starbase_client_order_id?stringClient order id of the user's own order (maker or taker side) submitted directly to Starbase via direct access; not returned for orders placed through the Deribit API; for self-trades this is the taker order's client order idAdvTradeGlobalUserTrade.starbase_client_order_id
starbase_match_id?numberOptional field containing the Starbase match identifier (present only for trades matched via Starbase)AdvTradeGlobalUserTrade.starbase_match_id
starbase_order_id?numberRaw Starbase order id of the user's order, in Starbase's own (non currency-prefixed) id namespace (present only for trades matched in Starbase)AdvTradeGlobalUserTrade.starbase_order_id
starbase_timestamp?numberOptional field: the Starbase causal timestamp of the trade, in nanoseconds since the UNIX epoch (present only for trades matched in Starbase)AdvTradeGlobalUserTrade.starbase_timestamp
stateAdvTradeGlobalOrderStateInUserTradeOrder state: "open", "filled", "rejected", "cancelled", "untriggered" or "archive" (if order was archived)AdvTradeGlobalUserTrade.state
tick_directionnumberDirection of the "tick" (0 = Plus Tick, 1 = Zero-Plus Tick, 2 = Minus Tick, 3 = Zero-Minus Tick).AdvTradeGlobalUserTrade.tick_direction
timestampnumberThe timestamp of the trade (milliseconds since the UNIX epoch)AdvTradeGlobalUserTrade.timestamp
trade_allocations?AdvTradeGlobalTradeAllocations[]List of allocations for Block RFQ pre-allocation. Each allocation specifies user_id, amount, and fee for the allocated part of the trade. For broker client allocations, a client_info object will be included.AdvTradeGlobalUserTrade.trade_allocations
trade_idstringUnique (per currency) trade identifierAdvTradeGlobalUserTrade.trade_id
trade_seqnumberThe sequence number of the trade within instrumentAdvTradeGlobalUserTrade.trade_seq
underlying_price?numberUnderlying price for implied volatility calculations (Options only)AdvTradeGlobalUserTrade.underlying_price
user_id?numberUser identifier for the account that executed the trade. For isolated trades, this is the subaccount ID.AdvTradeGlobalUserTrade.user_id

Built by Siebly. Open source SDKs for exchange APIs.