v1

latestOpenAPI 3.1.02026-07-26399062.0 KB
order-gateway

post/place-order

Request body

aidstring nullable

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.

cidinteger
d'B' | 'S' required
pstring required

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

poboolean required

Whether the order is post-only (maker-or-cancel)

qinteger required

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

sstring required

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

st'CancelIncoming' | 'CancelResting' | 'CancelBoth'

Controls how the matching engine handles an order that would trade against the submitter's own resting orders. Defaults to CancelIncoming.

tagstring nullable

Optional order tag; maximum 10 alphanumeric characters

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

Response

Order placed successfully

oidstring required

Order ID of the placed order; e.g. "ORD-1234567890"