API ReferenceExecution
Read one conditional order and its event trail
const url = 'https://exec.predictefy.com/v1/exec/conditional/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://exec.predictefy.com/v1/exec/conditional/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>'Requires Authorization: Bearer <api-key> with the trade scope. The append-only events array carries every transition with the evidence that caused it — the record that answers "why did this fire".
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Conditional (take-profit / stop-loss) order id.
Responses
Section titled “Responses”The conditional order plus its events.
object
An armed take-profit / stop-loss order. The stored artifact, its hash, its key id and any fire lease are deliberately absent from this shape and are never returned.
object
The trusted-edge country at arm time, re-applied to the venue geofence at fire.
Present on the single-order read only.
One append-only transition, with the evidence that caused it.
object
The trigger rule. Every optional field has an engine default that is stored explicitly on the armed row, so an order always says exactly what it meant.
object
The direction the reference price must cross.
The probability the reference must reach.
mark is the median of best bid, best ask and a fresh last trade; bid/ask select the executable side explicitly.
Consecutive qualifying samples required before the order triggers.
How long the condition must hold, measured on book timestamps.
No trigger while the book's spread is wider than this.
The qualifying quote must show at least this size.
Sugar. Rewritten to when from the stored order's side (a stop sells below and buys above; take-profit mirrors it), and echoed back on the stored rule.
Example
{ "success": true, "data": { "events": [ { "actor": "api" } ], "fireMode": "hosted", "status": "armed", "trigger": { "when": "at_or_above", "reference": "mark", "confirmations": 2, "dwellMs": 2000, "maxSpread": 0.1, "minSize": 1, "tpsl": "tp" } }}Missing, invalid, unknown, or revoked Predictefy API key.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The API key lacks the mandatory trade scope, or the account's plan does not include conditional orders (Pro is the minimum).
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The conditional order is missing or not owned by the caller, or the family is not enabled for this account.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}The authenticated execution token bucket is exhausted.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}Unexpected internal execution failure.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}Authentication, billing, or execution storage is temporarily unavailable.
object
object
Always present on errors; quote this id when reporting a failed request.
Present only when a venue error is attributed to a specific exchange.
Example
{ "success": false, "error": { "code": "VALIDATION_ERROR" }}