Flat Place Order

The FLATPLACE order command is virtually identical to using the PLACE order command with the flatten_first flag enabled. The only difference is syntax.

A potential benefit of using PLACE with flatten_first over FLATPLACE is if you want to allow closing orders to filter through a Trading Window using the closing_only_after filter. If after the 'closing only' time, the flatten_first is allowed to pass through, whereas FLATPLACE would be blocked outright.

FLATPLACE only closes open positions in the underlying instrument. It will not close any open limit orders. Using a PLACE command with flatten_first will close both open positions and pending orders.

Example Payloads

This example message will trigger a simple market order for BUY or SELL actions that will remain in-force for the rest of the trading day.

Buy or Sell (Market Orders)

Using FLATPLACE Order Command

key=your-secret-key;
command=flatplace;
account=sim101;
instrument=ES1!;
action=buy;
qty=1;
order_type=market;
tif=day;

Using PLACE Order Command

key=your-secret-key;
command=place;
account=sim101;
instrument=ES1!;
action=buy;
qty=1;
order_type=market;
tif=day;
flatten_first=true;

We will cease the examples here since all PLACE payloads will be identical to FLATPLACE payloads aside from the command name.

See the Place Order command and Examples pages for more use cases.