Skip to navigation

Get an execution

Serves one execution of the organisation; any other id is 404. Executions carry no version and no ETag.

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.

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 and balance readings included.

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

UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: 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, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: 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]+$"

0 = unattributed (discovered); set otherwise. int64 as a decimal JSON string

orgIdinteger
sideenum

UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: 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.

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

Denormalized from the order at recording (0 = none / discovered); 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
venueTsNsstring or nullOptionalformat: "^-?[0-9]+$"
int64 as a decimal JSON string
unscaledbooleanOptionalDeprecated

Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so a row is never served raw, whether or not this member holds the asset or instrument it references. Kept, deprecated, so a client generated from 0.3.2 still compiles; it goes at the next major.

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