Skip to navigation

Get an account

Serves one account of the organisation; any other id is 404.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

The record's id — a positive 32-bit integer the platform minted.

Query parameters

viewenumOptionalDefaults to latest

latest (the default) shows a row's pending proposal where one exists; approved shows what the platform enforces. Resources without proposals serve the same rows for both.

Allowed values:

Response

The account's row, rendered as the guide's Reads section describes: the position header and body field, the ETag, money as decimal strings.

accountIdinteger
Sticky entity key.
credentialIdinteger
The pipe this account is reached through.
displayNamestring

Empty-not-null.

externalRefstring

The venue's own account identifier — an attribute, never the id; with the credential, the key a discovery is idempotent on.

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

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

locationenum

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

orgIdinteger

The owning org — stamped by the owner from the credential's org, never client-supplied.

ownershipenum

HOUSE only exercised in the POC. 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:
pendingTransitionenum

ACTIVATE (a classification), AMEND (a re-classification — the proposed axes ride this record while the last approved record keeps enforcing), UNFREEZE, RETIRE; NONE otherwise. NONE is the unset sentinel: outputs only — as input, omit the field instead; explicit NONE refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict

purposeenum

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

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

temperatureenum

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:
versionstringformat: "^-?[0-9]+$"
Monotonic per entity. int64 as a decimal JSON string
pendingByUserIdinteger or nullOptional

The maker while a proposal is pending; 0 otherwise.

portfolioIdinteger or nullOptional

Single assignment in the POC; 0 = unassigned.

tradingCredentialIdinteger or nullOptional

The trading credential this account's orders go through when set (a read-only key discovers the account; a trading key at the same venue is designated here); absent or 0 = orders go through credentialId. Designated at classification, under dual control.

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 Accounts Request Bad Request Error
401
Get Accounts Request Unauthorized Error
403
Get Accounts Request Forbidden Error
404
Get Accounts Request Not Found Error
503
Get Accounts Request Service Unavailable Error