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

What the plan would place for this account and this order. The engine supplies every price; the request names the order and nothing else.

planId
string
required
clientOrderId
string
required

The client order id the placement will ride under. The token is bound to it, so a confirmation is spent on one submission rather than good for any order until it expires.

instrument
string
required
side
enum<string>
required
Available options:
buy,
sell
quantity
number
required
entryType
enum<string>
Available options:
market,
limit,
stop,
stop_limit
entryPrice
number | null

The resting entry's own price. Ignored for a market entry, whose ladder is measured from the mark at placement.

Response

The resolved plan and its token

WireExitPlanPreview (@trdrs/contracts): the resolved legs plus the token that binds them. The token is a signed binding over the order — the account, the client order id, the plan and its revision, the instrument, the side, the quantity and the entry — never over the prices: placement reloads the plan at that revision and re-resolves, so a preview proves what was agreed rather than carrying a price a client could have chosen. A market entry's levels are indicative for the same reason.

planId
string
required
planRevision
string
required
legs
object[]
required
managedQuantity
number
required
unmanagedQuantity
number
required

What the order carries that the plan does not protect.

engineManaged
boolean
required

True when the engine itself will ratchet the stop, rather than the venue holding it still.

token
string
required
expiresAt
integer
required

Epoch milliseconds