Skip to content

Latest commit

 

History

History
38 lines (33 loc) · 5 KB

BatchFuturesOrder.md

File metadata and controls

38 lines (33 loc) · 5 KB
Raw

BatchFuturesOrder

Properties

Name Type Description Notes
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 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 of position close - position_closed: canceled 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`: waiting to be traded - `finished`: finished [optional] [readonly]
Contract string Futures contract [optional]
Size int64 Order size. Specify positive number to make a bid, and negative number to ask [optional]
Iceberg int64 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]
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 Size left to be traded [optional] [readonly]
FillPrice 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 int32 Reference 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 prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion 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]

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