Get Replacement Candidates

The Get Replacement Candidates API returns the replacement candidates for a specific instrument, across a set of accounts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
accounts
array of objects
required
Accounts*
integer
Defaults to 5

The maximum number of replacement candidates to return.

string
required

The ID of the order to replace.

proposed_orders
array of objects
required
Proposed Orders*
boolean
Defaults to false

When true, use synthetic eval order book generated from price estimates instead of real market data.

account_constraint_relaxation
object | null

Per-constraint relaxed bounds the solver used to reach the orders
being replaced, keyed by the optimization account id
(account:sleeve) that solved under them. Candidates are evaluated
against these rather than the originals — the order under
replacement does not itself satisfy the original bound, so every
candidate would be rejected. Keyed per account because a bound
relaxed for one account does not hold for another.

valuation_config
object | null

Valuation configuration the caller resolved for the requesting org.
When absent, the replacer falls back to its own org-based
resolution.

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json