Skip to content

Latest commit

 

History

History
36 lines (32 loc) · 5.27 KB

File metadata and controls

36 lines (32 loc) · 5.27 KB

DeliveryOrder

Futures order details

Properties

Name Type Description Notes
id int Futures order ID [optional] [readonly]
user int User ID [optional] [readonly]
create_time float Creation time of order [optional] [readonly]
finish_time float Order finished time. Not returned if order is open [optional] [readonly]
finish_as str 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 str Order status - `open`: Pending - `finished`: Completed [optional] [readonly]
contract str Futures contract
size int Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders.
iceberg int Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. [optional]
price str 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]
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 str 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 Unfilled quantity [optional] [readonly]
fill_price str Fill price [optional] [readonly]
text str 订单自定义信息,用户可以用该字段设置自定义 ID,用户自定义字段必须满足以下条件: 1. 必须以 `t-` 开头 2. 不计算 `t-` ,长度不能超过 28 字节 3. 输入内容只能包含数字、字母、下划线(_)、中划线(-) 或者点(.) 除用户自定义信息以外,以下为内部保留字段,标识订单来源: - web: 网页 - api: API 调用 - app: 移动端 - auto_deleveraging: 自动减仓 - liquidation: ⽼经典模式仓位强制平仓 - liq-xxx: a. 新经典模式仓位强制平仓,包含逐仓、单向全仓、双向全仓⾮对冲仓位强平。 b. 统⼀账户单币种保证金模式逐仓强制平仓 - hedge-liq-xxx: 新经典模式双向全仓对冲部分强制平仓,即同时平多空仓位 - pm_liquidate: 统⼀账户跨币种保证金模式强制平仓 - comb_margin_liquidate: 统⼀账户组合保证金模式强制平仓 - scm_liquidate: 统⼀账户单币种保证金模式仓位强制平仓 - insurance: 保险 [optional]
tkfr str Taker fee [optional] [readonly]
mkfr str Maker fee [optional] [readonly]
refu int Referrer user ID [optional] [readonly]
auto_size str 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]
stp_id int 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]
stp_act str 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]
amend_text str The custom data that the user remarked when amending the order [optional] [readonly]

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