Skip to content

Latest commit

 

History

History
65 lines (43 loc) · 3.97 KB

OptionsOrder.md

File metadata and controls

65 lines (43 loc) · 3.97 KB
Raw

OptionsOrder

Properties

Name Type Description Notes
id number Options order ID [optional] [readonly] [default to undefined]
user number User ID [optional] [readonly] [default to undefined]
createTime number Creation time of order [optional] [readonly] [default to undefined]
finishTime number Order finished time. Not returned if order is open [optional] [readonly] [default to undefined]
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 [optional] [readonly] [default to undefined]
status string Order status - `open`: waiting to be traded - `finished`: finished [optional] [readonly] [default to undefined]
contract string Contract name [default to undefined]
size number Order size. Specify positive number to make a bid, and negative number to ask [default to undefined]
iceberg number Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size [optional] [default to undefined]
price string Order price. 0 for market order with `tif` set as `ioc` (USDT) [optional] [default to undefined]
close boolean Set as `true` to close the position, with `size` set to 0 [optional] [default to undefined]
isClose boolean Is the order to close position [optional] [readonly] [default to undefined]
reduceOnly boolean Set as `true` to be reduce-only order [optional] [default to undefined]
isReduceOnly boolean Is the order reduce-only [optional] [readonly] [default to undefined]
isLiq boolean Is the order for liquidation [optional] [readonly] [default to undefined]
tif string 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 number Size left to be traded [optional] [readonly] [default to undefined]
fillPrice string Fill price of the order [optional] [readonly] [default to undefined]
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] [default to undefined]
tkfr string Taker fee [optional] [readonly] [default to undefined]
mkfr string Maker fee [optional] [readonly] [default to undefined]
refu number Reference user ID [optional] [readonly] [default to undefined]
refr string Referrer rebate [optional] [readonly] [default to undefined]

Enum: OptionsOrder.FinishAs

  • Filled (value: 'filled')

  • Cancelled (value: 'cancelled')

  • Liquidated (value: 'liquidated')

  • Ioc (value: 'ioc')

  • AutoDeleveraged (value: 'auto_deleveraged')

  • ReduceOnly (value: 'reduce_only')

  • PositionClosed (value: 'position_closed')

  • ReduceOut (value: 'reduce_out')

Enum: OptionsOrder.Status

  • Open (value: 'open')

  • Finished (value: 'finished')

Enum: OptionsOrder.Tif

  • Gtc (value: 'gtc')

  • Ioc (value: 'ioc')

  • Poc (value: 'poc')