Get an algo instance
Serves one instance of the organisation, deleted or not; any other id is 404. The ETag is the instance’s configSeq — the token PUT /algos/instances/{id}/config takes as If-Match.
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.
Response
The instance's row: status is where it stands, the attribution fields who moved it. The ETag is the instance's configSeq.
The catalog version the instance runs (GET /algos/versions).
The document in force; 0 while none has been applied.
The latest staged document's sequence number — the ETag, and what If-Match takes on a config write.
When it was created — epoch nanoseconds as a decimal string.
The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.
The instance's id — the value its orders carry as algoInstanceId.
Why it last moved: a command, the organisation's halt, its first document applied, the engine's fault trip, or the engine's divergence check. The value set is append-only: read an unknown name as UNKNOWN.
The command behind the last move — a desk's, or the engine's report that moved it. The value set is append-only: read an unknown name as UNKNOWN.
When it last moved — epoch nanoseconds as a decimal string.
Where the instance stands: CREATED until its first document is applied, STOPPED or STARTED under the desk, ERROR after the engine's fault trip (left only by a stop), DELETED terminal. PENDING_APPROVAL and DISABLED are reserved and never served today. The value set is append-only: read an unknown name as UNKNOWN.
The instance's transition number: 1 at creation, one more on every move.
The user whose command last moved the instance; null when the engine or the platform's own rule did — lastCause says which.
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.