[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 3.11 KB

OptionsOrder.md

File metadata and controls

33 lines (29 loc) · 3.11 KB

OptionsOrder

Options order detail

Properties

Name Type Description Notes
id int Options 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 of position close [optional] [readonly]
status str Order status - `open`: waiting to be traded - `finished`: finished [optional] [readonly]
contract str Contract name
size int Order size. Specify positive number to make a bid, and negative number to ask
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 str Order price. 0 for market order with `tif` set as `ioc` (USDT) [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 [optional] [default to 'gtc']
left int Size left to be traded [optional] [readonly]
fill_price str Fill price of the order [optional] [readonly]
text str 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 str Taker fee [optional] [readonly]
mkfr str Maker fee [optional] [readonly]
refu int Reference user ID [optional] [readonly]
refr str Referrer rebate [optional] [readonly]

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