Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 3.39 KB

Order.md

File metadata and controls

37 lines (32 loc) · 3.39 KB

Order

Properties

Name Type Description Notes
Direction string direction, `buy` or `sell`
ReduceOnly bool `true` for reduce-only orders only [optional]
Triggered bool Whether the stop order has been triggered (Only for stop orders) [optional]
OrderId string Unique order identifier
Price float32 Price in base currency
TimeInForce string Order time in force: `"good_til_cancelled"`, `"fill_or_kill"`, `"immediate_or_cancel"`
Api bool `true` if created with API
OrderState string order state, `"open"`, `"filled"`, `"rejected"`, `"cancelled"`, `"untriggered"`
Implv float32 Implied volatility in percent. (Only if `advanced="implv"`) [optional]
Advanced string advanced type: `"usd"` or `"implv"` (Only for options; field is omitted if not applicable). [optional]
PostOnly bool `true` for post-only orders only
Usd float32 Option price in USD (Only if `advanced="usd"`) [optional]
StopPrice float32 stop price (Only for future stop orders) [optional]
OrderType string order type, `"limit"`, `"market"`, `"stop_limit"`, `"stop_market"`
LastUpdateTimestamp int32 The timestamp (seconds since the Unix epoch, with millisecond precision)
OriginalOrderType string Original order type. Optional field [optional]
MaxShow float32 Maximum amount within an order to be shown to other traders, 0 for invisible order.
ProfitLoss float32 Profit and loss in base currency. [optional]
IsLiquidation bool `true` if order was automatically created during liquidation
FilledAmount float32 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. [optional]
Label string user defined label (up to 32 characters)
Commission float32 Commission paid so far (in base currency) [optional]
Amount float32 It represents the requested order size. For perpetual and futures the amount is in USD units, for options it is amount of corresponding cryptocurrency contracts, e.g., BTC or ETH. [optional]
Trigger string Trigger type (Only for stop orders). Allowed values: `"index_price"`, `"mark_price"`, `"last_price"`. [optional]
InstrumentName string Unique instrument identifier [optional]
CreationTimestamp int32 The timestamp (seconds since the Unix epoch, with millisecond precision)
AveragePrice float32 Average fill price of the order [optional]

[Back to Model list] [Back to API list] [Back to README]