Place order
Authorizations
User session token
Body
Order side; buying ("B") or selling ("S")
B, S Order price in USD as decimal string; e.g. "1.2345"
Order quantity in contracts; e.g. 100, 1000
x >= 0Order symbol; e.g. XAU-PERP, EURUSD-PERP
Order time in force; e.g. "GTC", "IOC". "DAY" is accepted but deprecated and will be removed in a future release — use "GTC" instead.
Optional account ID. If omitted, the account is inferred from the connection: the user's default account, or the session account for an account-scoped session.
Optional client order ID; 64 bit integer
x >= 0Post-only ("maker-or-cancel"): false (default) lets the order take;
true makes it maker-only. When post-only, reprice_behavior selects
what happens if the order would cross on entry (default: reject).
Reprice behavior for an aggressive post-only order. Meaningful only when
post_only is true; ignored otherwise. Defaults to Reject (the order
is rejected if it would cross on entry).
rej, bo, tbl Self-trade prevention behavior. Defaults to CancelIncoming.
The short aliases xi, xr, and xb are also accepted for CancelIncoming,
CancelResting, and CancelBoth, respectively.
CancelIncoming: cancel the incoming aggressor order; resting orders remain on the book.CancelResting: cancel resting orders that would self-match; allow the incoming aggressor order.CancelBoth: cancel both the resting orders and the incoming aggressor order.
CancelIncoming, CancelResting, CancelBoth Optional order tag; maximum 10 alphanumeric characters
Response
Order placed successfully
Order ID of the placed order; e.g. "ORD-1234567890"