Order.md

Order

Properties

Name	Type	Description	Notes
direction	str	direction, `buy` or `sell`
reduce_only	bool	`true` for reduce-only orders only	[optional]
triggered	bool	Whether the stop order has been triggered (Only for stop orders)	[optional]
order_id	str	Unique order identifier
price	float	Price in base currency
time_in_force	str	Order time in force: `"good_til_cancelled"`, `"fill_or_kill"`, `"immediate_or_cancel"`
api	bool	`true` if created with API
order_state	str	order state, `"open"`, `"filled"`, `"rejected"`, `"cancelled"`, `"untriggered"`
implv	float	Implied volatility in percent. (Only if `advanced="implv"`)	[optional]
advanced	str	advanced type: `"usd"` or `"implv"` (Only for options; field is omitted if not applicable).	[optional]
post_only	bool	`true` for post-only orders only
usd	float	Option price in USD (Only if `advanced="usd"`)	[optional]
stop_price	float	stop price (Only for future stop orders)	[optional]
order_type	str	order type, `"limit"`, `"market"`, `"stop_limit"`, `"stop_market"`
last_update_timestamp	int	The timestamp (seconds since the Unix epoch, with millisecond precision)
original_order_type	str	Original order type. Optional field	[optional]
max_show	float	Maximum amount within an order to be shown to other traders, 0 for invisible order.
profit_loss	float	Profit and loss in base currency.	[optional]
is_liquidation	bool	`true` if order was automatically created during liquidation
filled_amount	float	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	str	user defined label (up to 32 characters)
commission	float	Commission paid so far (in base currency)	[optional]
amount	float	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	str	Trigger type (Only for stop orders). Allowed values: `"index_price"`, `"mark_price"`, `"last_price"`.	[optional]
instrument_name	str	Unique instrument identifier	[optional]
creation_timestamp	int	The timestamp (seconds since the Unix epoch, with millisecond precision)
average_price	float	Average fill price of the order	[optional]

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