Skip to navigation

Get an order

Serves one order of the organisation; any other id is 404. The ETag is the order’s version, a read token only.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The order's id — a positive 64-bit integer as decimal digits.

Response

The order's current row: status is where it stands, transition the last change that put it there. The ETag is the order's version.

acceptedAtNsstringformat: "^-?[0-9]+$"

The accept's consensus time, stamped by the owner — the anchor instructFreshnessNs measures from; carried on the record so a restored snapshot keeps the window. int64 as a decimal JSON string

accountIdinteger
clientOrderIdstring

The edge key echoed; never the venue key.

credentialIdinteger

The oe credential the owner RESOLVED at submit — the org's live canTrade credential for the account's venue, not the account's own read-only credential. The connector's fold filter is credentialId ∈ mine.

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

Derived from the deduplicated execution set — never from the venue's cumulative; rounded by the owner. 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

externalRefstring

The venue order id once bound (ACKNOWLEDGED or first evidence carrying it); empty until then.

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
leavesQtystringformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

qty - cumQty at a live status; 0 at any terminal. 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

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

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:
orgIdinteger

Owner-stamped.

provenanceenum

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

qtystringformat: "^-?[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

reasonenum

The transition's cause when one applies (UNKNOWN otherwise); the raw venue leg rides venueCode/venueText. 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

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:
statusenum

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

timeInForceenum

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:
tradingPolicyIdinteger

Which trading policy row — the organisation-wide default or a per-instrument one — the validation ran against.

tradingPolicyVersionstringformat: "^-?[0-9]+$"
The attribution pin's version half. int64 as a decimal JSON string
transitionenum

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

userIdinteger

The submitting user; actors of later commands ride those commands and the envelope's causation, never restamped here.

venueTextstring

The last reason triple's text leg; empty when none.

versionstringformat: "^-?[0-9]+$"

Per-order, monotonic, bumped on every row; a restored snapshot restates the last version. int64 as a decimal JSON string

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

Derived from the deduplicated execution set (half-even rounding); 0 = no fills. 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

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

The venue-async cancel window's base: set by CANCEL_REQUESTED, cleared (0) by CANCEL_REJECTED, mooted by terminals; feeds the pending-cancel backstop timer. Consumers answer 'is a cancel in flight' as live status AND nonzero here — there is no PENDING_CANCEL status to watch for. int64 as a decimal JSON string

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

First INSTRUCTED evidence time; 0 until instructed. int64 as a decimal JSON string

isExecutionsCompletebooleanOptional

Accounting closure: true if and only if the deduplicated execution set reconciles against the lifecycle (FILLED: the set equals qty; other terminals: the set equals venueCumQty where reported). False keeps the reconcile lane chasing fills — a venue's terminal status stands while this is false. a boolean; absent reads false

isPostOnlybooleanOptional

a boolean; absent reads false

isReduceOnlybooleanOptional

a boolean; absent reads false

lastFillPxstring 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

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

The most recent leg reported for this order, for a merged FIX-style rendering (LastQty/LastPx); 0 = none. On a bust or correction it describes the referenced trade, not the surviving fill, and a report about no leg carries the previous value forward — read cumQty/avgPx, never this pair, for what the set currently stands behind. 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

pricestring 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

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

The base of the venue-side reconcile window, the sibling of cancelRequestedAtNs: set by RECONCILE_REQUESTED, cleared (0) by the venue evidence that answers it. Stored rather than derived from the transition, because a restored snapshot restates every row as SNAPSHOT and a derived window would differ on a warm-started member. Consumers answer 'is a reconcile outstanding' as non-zero here — never by watching for a transition. int64 as a decimal JSON string

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

The venue's claimed cumulative — the cross-check watermark behind isExecutionsComplete; -1 = never reported. 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 -1 sentinel means unset

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

The per-order venue-time watermark; 0 = no venue evidence yet. 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 Orders Request Bad Request Error
401
Get Orders Request Unauthorized Error
403
Get Orders Request Forbidden Error
404
Get Orders Request Not Found Error
503
Get Orders Request Service Unavailable Error