Get an instance's document
Serves one document of the instance by its sequence number; any other instance or sequence number is 404. Documents carry no version and no ETag: a document is immutable once staged — its outcome is the only field that moves.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
The instance's id — a positive 32-bit integer the platform minted; the value an algo's orders carry as algoInstanceId.
A document's sequence number on its instance: 1 for the document the instance was created with, one more for every accepted write.
Response
One document of the instance as submitted — a name its author gave an account or an instrument reads as the id it named, the name beside it as a comment where it fits — with its outcome. Documents carry no version, so no ETag.
Every account the document references, once each, ascending — the accounts the instance may trade.
The write's Idempotency-Key, as sent.
The document's sequence number on its instance: 1 for the document the instance was created with, one more for every accepted write.
The engine's reason where it refused the document; empty otherwise.
The document as authored, comments included — at most 6144 bytes of UTF-8.
The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.
Every instrument the document references, once each, ascending — 64-bit ids as decimal strings.
STAGED until the engine answers, then APPLIED or REFUSED; PENDING_APPROVAL is reserved and never served today. The value set is append-only: read an unknown name as UNKNOWN.
When it was submitted — epoch nanoseconds as a decimal string.
When the engine's verdict landed — epoch nanoseconds as a decimal string; null while staged.
Reserved; always null.
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.