Skip to navigation

Get an execution

Serves one execution of the organisation; any other id is 404. Executions carry no version and no ETag. Needs orders:read or any orders capability.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

The execution’s id — a positive 64-bit integer as decimal digits.

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Response

One fill — an immutable economic event; a bust or a correction is its own row. Executions carry no version, so no ETag.

accountIdinteger
credentialIdinteger
executionIdstringformat: "^-?[0-9]+$"
int64 as a decimal JSON string
externalRefstring

The venue order id as carried by the fill event; the auto-attribution join key for discovered rows (both facts carry it).

fillPxstringformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value’s own scale — every fractional digit that scale states, trailing zeros included; never raw

fillQtystringformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

Always positive; kind gives the sign of its effect (BUST reverses). money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value’s own scale — every fractional digit that scale states, trailing zeros included; never raw

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

instrumentIdstringformat: "^-?[0-9]+$"
int64 as a decimal JSON string
kindenum

UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
liquidityenum

UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
orderIdstringformat: "^-?[0-9]+$"

The order; 0 = no order: awaiting attribution, unless provenance is MANUAL - a trade booked by hand, which no order placed and none ever will. int64 as a decimal JSON string

orgIdinteger
sideenum

UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
venueTradeIdstring

The venue execution id — the dedup key’s third component; a MANUAL execution’s is the reference it was booked under.

bookIdstring or nullOptionalformat: "^-?[0-9]+$"

Denormalized from the order at recording (0 = none: discovered, or booked by hand); re-stamped by attribution. int64 as a decimal JSON string

feestring or nullOptionalformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value’s own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the 0 sentinel means unset

feeAssetIdinteger or nullOptional
fillTsNsstring or nullOptionalformat: "^-?[0-9]+$"
int64 as a decimal JSON string
provenanceenumOptional

Where the execution came from: the connector’s evidence (ACK, PUSH, QUERY or SWEEP), or MANUAL - booked by a person and approved under the organisation’s risk rule, with orderId 0 and credentialId 0. UNKNOWN on an execution recorded before the field existed. UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

venueTsNsstring or nullOptionalformat: "^-?[0-9]+$"
int64 as a decimal JSON string

Errors

400
Get Executions Request Bad Request Error
401
Get Executions Request Unauthorized Error
403
Get Executions Request Forbidden Error
404
Get Executions Request Not Found Error
503
Get Executions Request Service Unavailable Error