| Succeeded |
bool |
Request execution result |
[optional] |
| Label |
string |
Error label, only exists if execution fails |
[optional] |
| Detail |
string |
Error detail, only present if execution failed and details need to be given |
[optional] |
| Id |
int64 |
Futures order ID |
[optional] [readonly] |
| User |
int32 |
User ID |
[optional] [readonly] |
| CreateTime |
float64 |
Creation time of order |
[optional] [readonly] |
| FinishTime |
float64 |
Order finished time. Not returned if order is open |
[optional] [readonly] |
| FinishAs |
string |
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 |
string |
Order status - `open`: Pending - `finished`: Completed |
[optional] [readonly] |
| Contract |
string |
Futures contract |
[optional] |
| Size |
int64 |
Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. |
[optional] |
| Iceberg |
int64 |
Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. |
[optional] |
| Price |
string |
Order price. Price of 0 with `tif` set to `ioc` represents a market order. |
[optional] |
| Close |
bool |
Set as `true` to close the position, with `size` set to 0 |
[optional] [default to false] |
| IsClose |
bool |
Is the order to close position |
[optional] [readonly] |
| ReduceOnly |
bool |
Set as `true` to be reduce-only order |
[optional] [default to false] |
| IsReduceOnly |
bool |
Is the order reduce-only |
[optional] [readonly] |
| IsLiq |
bool |
Is the order for liquidation |
[optional] [readonly] |
| Tif |
string |
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] [default to TIF_GTC] |
| Left |
int64 |
Unfilled quantity |
[optional] [readonly] |
| FillPrice |
string |
Fill price |
[optional] [readonly] |
| Text |
string |
User defined 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(.) Besides user defined information, reserved contents are listed below, denoting how the order is created: - web: from web - api: from API - app: from mobile phones - auto_deleveraging: from ADL - liquidation: from liquidation - insurance: from insurance |
[optional] |
| Tkfr |
string |
Taker fee |
[optional] [readonly] |
| Mkfr |
string |
Maker fee |
[optional] [readonly] |
| Refu |
int32 |
Referrer user ID |
[optional] [readonly] |
| AutoSize |
string |
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] |
| StpAct |
string |
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] |
| StpId |
int32 |
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] |