Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

Your firm’s API key (the API calls this the tenant key; trdrs_sk_…), server-to-server only.

Query Parameters

broker
string
account
string

Body

application/json
instrument
string
required
side
enum<string>
required
Available options:
buy,
sell
qty
number
required
clientOrderId
string
required

Caller-minted; stable across retries of one intent

orderType
enum<string>
default:market
Available options:
market,
limit,
stop,
stop_limit
limitPrice
number
triggerPrice
number
stopLimitPrice
number

The resting limit a 'stop_limit' entry converts to

stopLoss
object

Protective stop leg (bracket); price and tick-offset forms per the wire contract

takeProfit
object

Take-profit leg (the bracket target)

exitPlan
object

WireExitPlanPlacement (@trdrs/contracts): apply a saved plan to this order by reference. Send the plan, the revision you previewed, and the token you were given; do not send levels. The engine reloads the plan at that revision and refuses an edited plan, a deleted one, a changed account, drift or an expiry.

Example:
tif
enum<string>
Available options:
day,
gtc

Response

Placed. warnings reports non-fatal degradations (a short fill, unregistered auto-management). Surface them.

brokerOrderId
string
required
filledQty
number
required
avgFillPrice
number
required
exitPlan
object

Present when a saved exit plan was applied: which plan and revision, what actually placed, and whether the engine or the venue moves the stop.

warnings
object[]