POST Flat Place Order

Flattens any existing positions prior to placing an order.

Unlike reverse positions, flat placing an order will close any existing position and continue on to place the order regardless of whether or not the position existed. This is useful to ensure you are always cleanly entering a new positions. The equivalent of a webhook signal with the flatten_first flag enabled.

Close position and place order

POST /v1/api/accounts/{account}/orders/flatplace

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Path Parameters

Name	Type	Required	Description
account	string	Required	Name of account in NT8

Body

Name	Type	Required	Description
instrument	string	Required	Name of underlying instrument (e.g., "ES 12-25")
action	string	Required	BUY, SELL
quantity	integer	Required	Contract quantity of new order
orderType	string	Required	MARKET, LIMIT, STOPMARKET, STOPLIMIT
timeInForce	string	Required	DAY, GTC
limitPrice	float	Optional	Limit price when submitting limit order type
stopPrice	float	Optional	Stop price when submitting stop order type
ocoId	string	Optional	Create or append to OCO order by ID
strategy	string	Optional	ATM strategy name if opening with ATM template

Code Examples

Python

import requests

token = 'my-secret-token'

url = "https://app.crosstrade.io/v1/api/accounts/Sim101/orders/flatplace"
headers = {
    "Authorization": f"Bearer {token}",
    "Content-Type": "application/json"
}
data = {
    "instrument": "MES 12-25",
    "action": "BUY",
    "orderType": "MARKET",
    "quantity": 1,
    "timeInForce": "DAY"
    # "limitPrice": 5500
    # "stopPrice": 0,
    # "ocoId": "abc123",
    # "strategy": "MyAtmStrategy"
}

try:
    response = requests.post(url, headers=headers, json=data)
    print(f"Response Code: {response.status_code}, Response Text: {response.text}")
except Exception as e:
    print(f"An error occurred: {e}")

---

Response

200

{
    "orderId": "1ede9d7ad8124fd48e3177399bf90a04",
    "success": true
}

400

WebSocket API

This request can also be made over the WebSocket API. The account path parameter and request body fields are all passed inside args.

{
  "action": "rpc",
  "id": "my-request",
  "api": "FlatPlace",
  "args": {
    "account": "Sim101",
    "instrument": "ES 09-26",
    "action": "Buy",
    "orderType": "Market",
    "quantity": 1,
    "timeInForce": "Gtc"
  }
}