OrderCancel.md

OrderCancel

Spot order details

Properties

Name	Type	Description	Notes
id	String	Order ID	[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: - 101: from android - 102: from IOS - 103: from IPAD - 104: from webapp - 3: from web - 2: from apiv2 - apiv4: from apiv4	[optional]
amendText	String	The custom data that the user remarked when amending the order	[optional] [readonly]
succeeded	Boolean	Request execution result	[optional]
label	String	Error label, if any, otherwise an empty string	[optional]
message	String	Detailed error message, if any, otherwise an empty string	[optional]
createTime	String	Creation time of order	[optional] [readonly]
updateTime	String	Last modification time of order	[optional] [readonly]
createTimeMs	Long	Creation time of order (in milliseconds)	[optional] [readonly]
updateTimeMs	Long	Last modification time of order (in milliseconds)	[optional] [readonly]
status	StatusEnum	Order status - `open`: to be filled - `closed`: closed order - `cancelled`: cancelled	[optional] [readonly]
currencyPair	String	Currency pair
type	TypeEnum	Order Type - limit : Limit Order - market : Market Order	[optional]
account	String	Account type, spot - spot account, margin - leveraged account, unified - unified account	[optional]
side	SideEnum	Buy or sell order
amount	String	Trading quantity When `type` is `limit`, it refers to the base currency (the currency being traded), such as `BTC` in `BTC_USDT` When `type` is `market`, it refers to different currencies based on the side: - `side`: `buy` refers to quote currency, `BTC_USDT` means `USDT` - `side`: `sell` refers to base currency, `BTC_USDT` means `BTC`
price	String	Trading price, required when `type`=`limit`	[optional]
timeInForce	TimeInForceEnum	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]
iceberg	String	Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported	[optional]
autoBorrow	Boolean	Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough	[optional]
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]
left	String	Amount left to fill	[optional] [readonly]
filledAmount	String	Amount filled	[optional] [readonly]
fillPrice	String	Total filled in quote currency. Deprecated in favor of `filled_total`	[optional] [readonly]
filledTotal	String	Total filled in quote currency	[optional] [readonly]
avgDealPrice	String	Average fill price	[optional] [readonly]
fee	String	Fee deducted	[optional] [readonly]
feeCurrency	String	Fee currency unit	[optional] [readonly]
pointFee	String	Points used to deduct fee	[optional] [readonly]
gtFee	String	GT used to deduct fee	[optional] [readonly]
gtMakerFee	String	GT amount used to deduct maker fee	[optional] [readonly]
gtTakerFee	String	GT amount used to deduct taker fee	[optional] [readonly]
gtDiscount	Boolean	Whether GT fee deduction is enabled	[optional] [readonly]
rebatedFee	String	Rebated fee	[optional] [readonly]
rebatedFeeCurrency	String	Rebated fee currency unit	[optional] [readonly]
stpId	Integer	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]
stpAct	StpActEnum	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]
finishAs	FinishAsEnum	How the order was finished. - open: processing - filled: filled totally - cancelled: manually cancelled - ioc: time in force is `IOC`, finish immediately - stp: cancelled because self trade prevention	[optional] [readonly]
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]

Enum: StatusEnum

Name	Value
OPEN	"open"
CLOSED	"closed"
CANCELLED	"cancelled"

Enum: TypeEnum

Name	Value
LIMIT	"limit"
MARKET	"market"

Enum: SideEnum

Name	Value
BUY	"buy"
SELL	"sell"

Enum: TimeInForceEnum

Name	Value
GTC	"gtc"
IOC	"ioc"
POC	"poc"
FOK	"fok"

Enum: StpActEnum

Name	Value
CN	"cn"
CO	"co"
CB	"cb"
MINUS	"-"

Enum: FinishAsEnum

Name	Value
OPEN	"open"
FILLED	"filled"
CANCELLED	"cancelled"
IOC	"ioc"
STP	"stp"