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.

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