FuturesOrder.md

FuturesOrder

Futures order details

Properties

Name	Type	Description	Notes
id	Long	Futures order ID	[optional] [readonly]
user	Integer	User ID	[optional] [readonly]
createTime	Double	Creation time of order	[optional] [readonly]
updateTime	Double	OrderUpdateTime	[optional] [readonly]
finishTime	Double	Order finished time. Not returned if order is open	[optional] [readonly]
finishAs	FinishAsEnum	How the order was finished: - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set - position_closed: cancelled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention	[optional] [readonly]
status	StatusEnum	Order status - `open`: Pending - `finished`: Completed	[optional] [readonly]
contract	String	Futures contract
size	String	Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders.
iceberg	String	Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees.	[optional]
price	String	Required. Order Price; a price of 0 with `tif` as `ioc` represents a market order.
close	Boolean	Set as `true` to close the position, with `size` set to 0	[optional]
isClose	Boolean	Is the order to close position	[optional] [readonly]
reduceOnly	Boolean	Set as `true` to be reduce-only order	[optional]
isReduceOnly	Boolean	Is the order reduce-only	[optional] [readonly]
isLiq	Boolean	Is the order for liquidation	[optional] [readonly]
tif	TifEnum	Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee - fok: FillOrKill, fill either completely or none	[optional]
left	String	Unfilled quantity	[optional] [readonly]
fillPrice	String	Fill price	[optional] [readonly]
text	String	Custom order information. If not empty, must follow the rules below: 1. Prefixed with `t-` 2. No longer than 28 bytes without `t-` prefix 3. Can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) In addition to user-defined information, the following are internal reserved fields that identify the order source: - web: Web - api: API call - app: Mobile app - auto_deleveraging: Automatic deleveraging - liquidation: Forced liquidation of positions under the old classic mode - liq-xxx: a. Forced liquidation of positions under the new classic mode, including isolated margin, one-way cross margin, and non-hedged positions under two-way cross margin. b. Forced liquidation of isolated positions under the unified account single-currency margin mode - hedge-liq-xxx: Forced liquidation of hedged positions under the new classic mode two-way cross margin, i.e., simultaneously closing long and short positions - pm_liquidate: Forced liquidation under unified account multi-currency margin mode - comb_margin_liquidate: Forced liquidation under unified account portfolio margin mode - scm_liquidate: Forced liquidation of positions under unified account single-currency margin mode - insurance: Insurance - clear: Contract delisting withdrawal	[optional]
tkfr	String	Taker fee	[optional] [readonly]
mkfr	String	Maker fee	[optional] [readonly]
refu	Integer	Referrer user ID	[optional] [readonly]
autoSize	AutoSizeEnum	Set side to close dual-mode position. `close_long` closes the long side; while `close_short` the short one. Note `size` also needs to be set to 0	[optional]
stpId	Integer	Orders between users in the same `stp_id` group are not allowed to be self-traded 1. If the `stp_id` of two orders being matched is non-zero and equal, they will not be executed. Instead, the corresponding strategy will be executed based on the `stp_act` of the taker. 2. `stp_id` returns `0` by default for orders that have not been set for `STP group`	[optional] [readonly]
stpAct	StpActEnum	Self-Trading Prevention Action. Users can use this field to set self-trade prevention strategies 1. After users join the `STP Group`, they can pass `stp_act` to limit the user's self-trade prevention strategy. If `stp_act` is not passed, the default is `cn` strategy. 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter. 3. If the user did not use `stp_act` when placing the order, `stp_act` will return '-' - cn: Cancel newest, cancel new orders and keep old ones - co: Cancel oldest, cancel old orders and keep new ones - cb: Cancel both, both old and new orders will be cancelled	[optional]
amendText	String	The custom data that the user remarked when amending the order	[optional] [readonly]
pid	Long	Position ID	[optional]
marketOrderSlipRatio	String	Custom maximum slippage rate for market orders. If not provided, the default contract settings will be used	[optional]
posMarginMode	String	Position Margin Mode isolated - Isolated Margin, cross - Cross Margin, only passed in simple split position mode	[optional]
actionMode	String	Processing Mode When placing an order, different fields are returned based on the action_mode - `ACK`: Asynchronous mode, returns only key order fields - `RESULT`: No clearing information - `FULL`: Full mode (default)	[optional]
tpslTpTriggerPrice	String	Take profit price	[optional]
tpslSlTriggerPrice	String	Stop loss price	[optional]
tpslTpBboType	String	Take profit BBO type	[optional]
tpslSlBboType	String	Stop loss BBO type	[optional]

Enum: FinishAsEnum

Name	Value
FILLED	"filled"
CANCELLED	"cancelled"
LIQUIDATED	"liquidated"
IOC	"ioc"
AUTO_DELEVERAGED	"auto_deleveraged"
REDUCE_ONLY	"reduce_only"
POSITION_CLOSED	"position_closed"
REDUCE_OUT	"reduce_out"
STP	"stp"

Enum: StatusEnum

Name	Value
OPEN	"open"
FINISHED	"finished"

Enum: TifEnum

Name	Value
GTC	"gtc"
IOC	"ioc"
POC	"poc"
FOK	"fok"

Enum: AutoSizeEnum

Name	Value
LONG	"close_long"
SHORT	"close_short"

Enum: StpActEnum

Name	Value
CO	"co"
CN	"cn"
CB	"cb"
MINUS	"-"