Skip to navigation

Get the capital view

The organisation’s capital view: per account once ACTIVE and not deleted, what its margin wallets could shed and stay NORMAL under every limit, what the limits would let leave and the top-up back to NORMAL; then totals by venue and location. A query parameter is 400, minGlobalSequence aside; without the surface, 503 RISK_UNAVAILABLE. Needs risk:read or any risk capability.

Authentication

AuthorizationBearer

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

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Response

The capital view: the accounts, account ascending, then the totals by venue and by location, keys ascending. The position the headers state and the body restates was taken before the rows were read, so a row that moved meanwhile is newer than it, never older.

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

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

accountslist of objects

One row per account of the organisation that has been ACTIVE and is not deleted — a disabled one included; one still PENDING_APPROVAL or DRAFT has no posture yet and no row — account ascending.

byVenuelist of objects
The totals by venue, keyed by the venue's name, keys ascending.
byLocationlist of objects

The totals by location — CUSTODIAN (the custody share) and EXCHANGE — keys ascending.

Errors

400
Get Capital Risk Request Bad Request Error
401
Get Capital Risk Request Unauthorized Error
403
Get Capital Risk Request Forbidden Error
503
Get Capital Risk Request Service Unavailable Error