Flag Values

Orders and Offers can use Flags to indicate different functionalities. Here we list the details of the possible flags values that can be seen or used depending on the interaction.

πŸ“˜

Multiple Flags

You may sum flag values to pass multiple flags. For example passing 4160 (64 + 4096) means hidden post only.
Default value is 0.

Order Flags

FlagTypeValueDescription
Hiddenint64The hidden order option ensures an order does not appear in the order book; thus does not influence other market participants.

To toggle 'visible on hit', add a meta object to your order with {make_visible: 1}.
Closeint512Close position if position present.
Reduce Onlyint1024Ensures that the executed order does not flip the opened position.
Post Onlyint4096The post-only limit order option ensures the limit order will be added to the order book and not match with a pre-existing order unless the pre-existing order is a hidden order.
OCOint16384The one cancels other order option allows you to place a pair of orders stipulating that if one order is executed fully or partially, then the other is automatically canceled.
No Var Ratesint524288Excludes variable rate funding offers from matching against this order, if on margin

Offer Flags

Hiddenint64The hidden offer option ensures an offer does not appear in the offer book; thus does not influence other market participants.