Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

User session token

Body

application/json
d
enum<string>
required

Order side; buying ("B") or selling ("S")

Available options:
B,
S
p
string
required

Order price in USD as decimal string; e.g. "1.2345"

q
integer<int64>
required

Order quantity in contracts; e.g. 100, 1000

Required range: x >= 0
s
string
required

Order symbol; e.g. XAU-PERP, EURUSD-PERP

tif
string
required

Order time in force; e.g. "GTC", "IOC". "DAY" is accepted but deprecated and will be removed in a future release — use "GTC" instead.

aid
string | null

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.

cid
null | integer<int64>

Optional client order ID; 64 bit integer

Required range: x >= 0
po
boolean

Post-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).

rb
enum<string>

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).

Available options:
rej,
bo,
tbl
st
enum<string>

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.
Available options:
CancelIncoming,
CancelResting,
CancelBoth
tag
string | null

Optional order tag; maximum 10 alphanumeric characters

Response

200 - application/json

Initial margin requirement preview

im
string
required

Initial margin requirement for the order; e.g. "1000.00"

im_pct
string
required

Initial margin percentage for the order symbol

mult
string
required

Multiplier for the order symbol

pos
integer<int64>
required

Current signed position in the order symbol