Order.md

Order

Properties

Name	Type	Description	Notes
id	string	Order ID	[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: - 101: from android - 102: from IOS - 103: from IPAD - 104: from webapp - 3: from web - 2: from apiv2 - apiv4: from apiv4 pm_liquidate, comb_margin_liquidate, and scm_liquidate represent cross-margin liquidation orders liquidate represents isolated-margin liquidation orders	[optional] [default to undefined]
amendText	string	The custom data that the user remarked when amending the order	[optional] [readonly] [default to undefined]
createTime	string	Creation time of order	[optional] [readonly] [default to undefined]
updateTime	string	Last modification time of order	[optional] [readonly] [default to undefined]
createTimeMs	number	Creation time of order (in milliseconds)	[optional] [readonly] [default to undefined]
updateTimeMs	number	Last modification time of order (in milliseconds)	[optional] [readonly] [default to undefined]
status	string	Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled	[optional] [readonly] [default to undefined]
currencyPair	string	Currency pair	[default to undefined]
tradeQuote	string	Actual quote currency used for the trade; can be specified only in a unified market	[optional] [default to undefined]
type	string	Order Type - limit : Limit Order - market : Market Order	[optional] [default to 'limit']
account	string	Account type, spot - spot account, margin - leveraged account, unified - unified account	[optional] [default to 'spot']
side	string	Buy or sell order	[default to undefined]
amount	string	Trade amount When `type` is `limit`, this is the base currency to trade (the currency being bought or sold), e.g. `BTC` in `BTC_USDT`. When `type` is `market`, the meaning depends on the side: - `side`: `buy` refers to the quote currency, e.g. `USDT` in `BTC_USDT` - `side`: `sell` refers to the base currency, e.g. `BTC` in `BTC_USDT`	[default to undefined]
price	string	Trading price, required when `type`=`limit`	[optional] [default to undefined]
timeInForce	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 Only `ioc` and `fok` are supported when `type`=`market`	[optional] [default to 'gtc']
iceberg	string	Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported	[optional] [default to undefined]
autoBorrow	boolean	Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough	[optional] [default to undefined]
autoRepay	boolean	Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order	[optional] [default to undefined]
left	string	Amount left to fill	[optional] [readonly] [default to undefined]
filledAmount	string	Amount filled	[optional] [readonly] [default to undefined]
fillPrice	string	Total filled in quote currency. Deprecated in favor of `filled_total`	[optional] [readonly] [default to undefined]
filledTotal	string	Total filled in quote currency	[optional] [readonly] [default to undefined]
avgDealPrice	string	Average fill price	[optional] [readonly] [default to undefined]
fee	string	Fee deducted	[optional] [readonly] [default to undefined]
feeCurrency	string	Fee currency unit	[optional] [readonly] [default to undefined]
pointFee	string	Points used to deduct fee	[optional] [readonly] [default to undefined]
gtFee	string	GT used to deduct fee	[optional] [readonly] [default to undefined]
gtMakerFee	string	GT amount used to deduct maker fee	[optional] [readonly] [default to undefined]
gtTakerFee	string	GT amount used to deduct taker fee	[optional] [readonly] [default to undefined]
gtDiscount	boolean	Whether GT fee deduction is enabled	[optional] [readonly] [default to undefined]
rebatedFee	string	Rebated fee	[optional] [readonly] [default to undefined]
rebatedFeeCurrency	string	Rebated fee currency unit	[optional] [readonly] [default to undefined]
stpId	number	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] [default to undefined]
stpAct	string	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] [default to undefined]
finishAs	string	How the order finished: - open: Pending processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled by liquidation - small: Order size too small - depth_not_enough: Cancelled due to insufficient order book depth - trader_not_enough: Cancelled due to insufficient counterparty liquidity - ioc: Not filled immediately because time-in-force is IOC - poc: Post-only requirement not met because time-in-force is set to poc (maker-only); rejected after being detected as taker - fok: Not fully filled immediately because time-in-force is FOK - stp: Cancelled due to self-trade prevention - price_protect_cancelled: Cancelled due to price protection - unknown: Unknown	[optional] [readonly] [default to undefined]
actionMode	string	Processing Mode: When placing an order, different fields are returned based on action_mode. This field is only valid during the request and is not included in the response result ACK: Asynchronous mode, only returns key order fields RESULT: No clearing information FULL: Full mode (default)	[optional] [default to undefined]
slippage	string	Maximum supported slippage ratio for Spot Market Order Placement, calculated based on the latest market price at the time of order placement as the benchmark (Example: 0.03 means 3%)	[optional] [default to undefined]
stopProfit	SpotOrderStopProfit		[optional] [default to undefined]
stopLoss	SpotOrderStopLoss		[optional] [default to undefined]

Enum: Order.Status

• Open (value: 'open')

• Closed (value: 'closed')

• Cancelled (value: 'cancelled')

Enum: Order.Type

• Limit (value: 'limit')

• Market (value: 'market')

Enum: Order.Side

• Buy (value: 'buy')

• Sell (value: 'sell')

Enum: Order.TimeInForce

• Gtc (value: 'gtc')

• Ioc (value: 'ioc')

• Poc (value: 'poc')

• Fok (value: 'fok')

Enum: Order.StpAct

• Cn (value: 'cn')

• Co (value: 'co')

• Cb (value: 'cb')

• Minus (value: '-')

Enum: Order.FinishAs

• Open (value: 'open')

• Filled (value: 'filled')

• Cancelled (value: 'cancelled')

• LiquidateCancelled (value: 'liquidate_cancelled')

• DepthNotEnough (value: 'depth_not_enough')

• TraderNotEnough (value: 'trader_not_enough')

• Small (value: 'small')

• Ioc (value: 'ioc')

• Poc (value: 'poc')

• Fok (value: 'fok')

• Stp (value: 'stp')

• PriceProtectCancelled (value: 'price_protect_cancelled')

• Unknown (value: 'unknown')