Skip to content

Latest commit

 

History

History
47 lines (43 loc) · 5.35 KB

BatchOrder.md

File metadata and controls

47 lines (43 loc) · 5.35 KB

BatchOrder

Batch order details

Properties

Name Type Description Notes
order_id str Order ID [optional]
amend_text str The custom data that the user remarked when amending the order [optional]
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(.) [optional]
succeeded bool Whether the batch of orders succeeded [optional]
label str Error label, if any, otherwise an empty string [optional]
message str Detailed error message, if any, otherwise an empty string [optional]
id str Order ID [optional] [readonly]
create_time str Creation time of order [optional] [readonly]
update_time str Last modification time of order [optional] [readonly]
create_time_ms int Creation time of order (in milliseconds) [optional] [readonly]
update_time_ms int Last modification time of order (in milliseconds) [optional] [readonly]
status str Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled [optional] [readonly]
currency_pair str Currency pair [optional]
type str Order Type - limit : Limit Order - market : Market Order [optional] [default to 'limit']
account str Account type. spot - use spot account; margin - use margin account; cross_margin - use cross margin account, unified - unified account [optional] [default to 'spot']
side str Order side [optional]
amount str Trade amount [optional]
price str Order price [optional]
time_in_force str 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] [default to 'gtc']
iceberg str Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. [optional]
auto_borrow bool Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. [optional]
auto_repay bool 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 str Amount left to fill [optional] [readonly]
filled_amount str Amount traded to fill [optional] [readonly]
fill_price str Total filled in quote currency. Deprecated in favor of `filled_total` [optional] [readonly]
filled_total str Total filled in quote currency [optional] [readonly]
avg_deal_price str Average fill price [optional] [readonly]
fee str Fee deducted [optional] [readonly]
fee_currency str Fee currency unit [optional] [readonly]
point_fee str Points used to deduct fee [optional] [readonly]
gt_fee str GT used to deduct fee [optional] [readonly]
gt_discount bool Whether GT fee discount is used [optional] [readonly]
rebated_fee str Rebated fee [optional] [readonly]
rebated_fee_currency str Rebated fee currency unit [optional] [readonly]
stp_id int 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]
stp_act str Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion 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]
finish_as str 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]

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