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
brokerOrderId
string
required
instrument
string
required
side
enum<string>
required
Available options:
buy,
sell
qty
number
required
orderType
enum<string>
required
Available options:
limit,
stop,
stop_limit
price
number
required

A limit's resting price, a stop's trigger. For stop_limit, its trigger

clientOrderId
string
required
stopLimitPrice
number

Required for stop_limit: the limit the trigger converts to

stopLoss
object | null

Bracket-leg end state: null removes, object sets, omit leaves

takeProfit
object | null
restoreBracket
object

The current bracket, for restore-on-reject

Response

The replace settled. Read outcome.

outcome
enum<string>
required
Available options:
amended,
replaced,
gone,
restored,
restored_without_bracket,
unconfirmed,
order_lost
brokerOrderId
string | null
required

The surviving order id (a composite re-place mints a new one)

message
string | null