| succeeded |
bool |
Whether the batch of orders succeeded |
[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 |
int |
Futures order ID |
[optional] [readonly] |
| user |
int |
User ID |
[optional] [readonly] |
| create_time |
double |
Creation time of order |
[optional] [readonly] |
| finish_time |
double |
Order finished time. Not returned if order is open |
[optional] [readonly] |
| finish_as |
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 of position close |
[optional] [readonly] |
| status |
string |
Order status - `open`: waiting to be traded - `finished`: finished |
[optional] [readonly] |
| contract |
string |
Futures contract |
[optional] |
| size |
int |
Order size. Specify positive number to make a bid, and negative number to ask |
[optional] |
| iceberg |
int |
Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size |
[optional] |
| price |
string |
Order price. 0 for market order with `tif` set as `ioc` |
[optional] |
| close |
bool |
Set as `true` to close the position, with `size` set to 0 |
[optional] [default to false] |
| is_close |
bool |
Is the order to close position |
[optional] [readonly] |
| reduce_only |
bool |
Set as `true` to be reduce-only order |
[optional] [default to false] |
| is_reduce_only |
bool |
Is the order reduce-only |
[optional] [readonly] |
| is_liq |
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 'gtc'] |
| left |
int |
Size left to be traded |
[optional] [readonly] |
| fill_price |
string |
Fill price of the order |
[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 |
int |
Reference user ID |
[optional] [readonly] |
| auto_size |
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] |