Enums Definitions

TimeInForce

Time in Force is a special strategy used during trading. It is used to specify how long an order shall remain active before being executed or expiring.

Note: Order fills include self-fills. Market orders are not supported by the Time in Force strategy.

Param	Description
GTC	Good Till Canceled, Expires only when canceled
GTT	Good Till Time, Expires at a specified time
IOC	Immediate Or Cancel, Execute the portions that can be executed immediately and cancel the rest; this does not enter the order book.
FOK	Fill Or Kill, Cancel if the order cannot be completely filled.
RPI	Retail Price Improvement, Provides better-than-market execution for retail orders.

Retail Price Improvement (RPI)

Warning

Please note that the RPI feature is currently under internal development and testing, and has not been officially released for public use. In Phase 1, it supports Futures only (Spot and Margin are not supported).

RPI (Retail Price Improvement) order is a new type of order designed to provide retail traders with more targeted market liquidity and better execution prices.
RPI orders are subject to counterparty restrictions during matching and can only be executed against non-algorithmic, non-API retail orders. This mechanism aims to offer retail users a better trading experience while allowing market makers to engage in passive market making within a more controlled risk environment.Currently, only specific market maker partners are allowed to place RPI orders.

For more details, please refert to What is an RPI Order

STP (Self-Trade Prevention)

Self-Trade Prevention is an option in advanced settings. It is not selected by default. If you specify STP when placing orders, your order won't be matched by another one which is also yours. Conversely, if STP is not specified in advanced, your order can be matched by another one of your own orders. It should be noted that only the taker's protection strategy is effective.

For spot STP, it should be noted that the STP function only occurs at the UID level, and spot already supports the master account level STP whitelist function. If needed, please join our official API Telegram group: https://t.me/KuCoin_API, or contact your account manager.

For futures STP, STP defaults to the master-UID level. There is no need to enable the whitelist function. However, you need to carry the "stp" parameter when placing an order. After activating this, the master-UID and all sub-UIDs under the master-UID cannot run self-executions.

Param	Description
DC	Decrease and Cancel, Cancel the order with smaller size and change the order with larger size to the difference between old and new
CO	Cancel old, Cancel the old order
CN	Cancel new, Cancel the new order
CB	Cancel both, Cancel both sides

Hidden Orders and Iceberg Orders (Hidden & Iceberg)

Hidden orders and iceberg orders can be set in advanced settings (iceberg orders are a special type of hidden order). When placing limit orders or stop limit orders, you can choose to execute according to either hidden orders or iceberg orders.

Hidden orders are not shown in order books.

Unlike hidden orders, iceberg orders are divided into visible and hidden portions. When engaging in iceberg orders, visible order sizes must be set. The minimum visible size for an iceberg order is 1/20 of the total order size.

When matching, the visible portions of iceberg orders are matched first. Once the visible portions are fully matched, hidden portions will emerge. This will continue until the order is fully filled.

Note:

The system will charge taker fees for hidden orders and iceberg orders.

If you simultaneously set iceberg orders and hidden orders, your order will default to an iceberg order for execution.

Cancel Reason for Unified Trading

cS	cancelReason
USER	You have canceled the order.
IOC	Unfilled portion of Immediate or Cancel (IOC) order canceled.
FOK	Unfilled Fill or Kill (FOK) order canceled.
POST_ONLY	Post-only order would have been filled and was canceled instead.
ORDER_BOOK_FULL	Order book is busy. Please try again later.
STP	Self‑trade protection triggered.
ORDER_EXPIRED	Good Till Time (GTT) order expired due to timeout.
ORDER_NOT_MATCH	Self‑trade order ID mismatch.
NO_SYMBOL	Trading pair not found.
NO_ENOUGH_BALANCE	Insufficient available balance.
NO_MAKER	No matching orders in the order book.
ZERO_SIZE	Matchable amount is 0.
TOO_MANY_ORDER_MATCHED	Matched amount exceeds limit.
PRICE_LIMITED	Price protection triggered.
OP_EXPIRED	Request expired.
GTT_PARAM_ERROR	Good Till Time (GTT) parameter error.
EXCEPTION_ORDER	Order error.
ALTER_ORDER_CANCEL_OLD_ORDER	Order modified, old order canceled.
ALTER_ORDER_CANCEL_NEW_ORDER	Order modified, new order canceled.
FOK_REPEAT	Duplicate Fill or Kill (FOK) order.
MARKET	No matching orders in the order book.
MATCH_COUNT_LIMIT	Exceeded 1,000 matches for a single order, unfilled portion canceled.
PRICE_OUT_OF_RANGE	No matching orders in the specified price range.
CLOSE_ORDER_WITHOUT_POSITION	No position remaining, close order canceled.
NO_ENOUGH_MARGIN_SIZE	Insufficient margin for the order.
ADL	Position is undergoing auto‑deleveraging (ADL).
NO_MARGIN_SIZE_LARGER_THAN_POSITION	Reduce‑only order size exceeds position size.
WORSE_THAN_BANKRUPT_PRICE	The order price is higher (when short) or lower (when long) than the position bankruptcy price.
CANCEL_BY_FUNDING_SETTLE	Funds are being settled. Please try again later.
CHANGE_RISK_LIMIT	Risk limit is currently being adjusted. Please try again later.
WHITE_USER_BALANCE_INSUFFICIENT	Insufficient balance.
CANCEL_BY_CONTRACT_SETTLE	Contract is being settled. Please try again later.
CANCEL_BY_SYSTEM_ERR	System error.
CANCEL_BY_DUPLICATED_ID	Duplicate ID.
BORROWED_FUNDS_ADL	Lending pool limit exceeded, auto‑repay triggered.
EXCEEDED_ACCOUNT_LIABILITY_LIMIT	Order canceled due to Auto‑Repay.
LIQUIDATION	Liquidation process triggered.
POSITION_SHORTCUT	Take‑profit or stop‑loss triggered.
SYSTEM_CANCEL	Order canceled by the system.
iceFrogFrozen	Order canceled due to restrictions on certain account features.
PRICE_OUT_OF_RANGE	No matching orders in the specified price range.

TimeInForce#

Retail Price Improvement (RPI)#

STP (Self-Trade Prevention)#

Hidden Orders and Iceberg Orders (Hidden & Iceberg)#

Cancel Reason for Unified Trading#

TimeInForce

Retail Price Improvement (RPI)

STP (Self-Trade Prevention)

Hidden Orders and Iceberg Orders (Hidden & Iceberg)

Cancel Reason for Unified Trading