Skip to content

BatchOrder.md

Latest commit

 

History

History
78 lines (63 loc) · 4.06 KB

BatchOrder.md

File metadata and controls

78 lines (63 loc) · 4.06 KB
Raw

BatchOrder

Batch order details

Properties

Name Type Description Notes
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(.) [optional]
succeeded Boolean Whether the batch of orders succeeded [optional]
label String Error label, if any, otherwise an empty string [optional]
message String Detailed error message, if any, otherwise an empty string [optional]
id String Order ID [optional] [readonly]
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`: filled - `cancelled`: cancelled [optional] [readonly]
currencyPair String Currency pair [optional]
type TypeEnum Order type. limit - limit order [optional]
account AccountEnum Account type. spot - use spot account; margin - use margin account; cross_margin - use cross margin account [optional]
side SideEnum Order side [optional]
amount String Trade amount [optional]
price String Order price [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 [optional]
iceberg String Amount to display for the iceberg order. Null or 0 for normal orders. Set to -1 to hide the order completely [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` cannot be both set to true in one order. [optional]
left String Amount left to fill [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]
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]
gtDiscount Boolean Whether GT fee discount is used [optional] [readonly]
rebatedFee String Rebated fee [optional] [readonly]
rebatedFeeCurrency String Rebated fee currency unit [optional] [readonly]

Enum: StatusEnum

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

Enum: TypeEnum

Name Value
LIMIT "limit"

Enum: AccountEnum

Name Value
SPOT "spot"
MARGIN "margin"
CROSS_MARGIN "cross_margin"

Enum: SideEnum

Name Value
BUY "buy"
SELL "sell"

Enum: TimeInForceEnum

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