Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

Your firm’s API key (the API calls this the tenant key; trdrs_sk_…), server-to-server only.

Query Parameters

broker
string
account
string

Response

The account at one revision

WireAccountSnapshot (@trdrs/contracts): the whole account at one revision. This is the body of this endpoint and of every account frame on the stream — one shape, not two. It replaced three independently timed reads, which no client could tell apart from one coherent picture. Apply it by the revision and nothing else: keep the newest frame you have for this accountId, drop anything at or behind it, and replace your whole picture with anything ahead of it. A frame that skips revisions is still complete, so there is nothing to recover and no resync to make. Never compute a revision of your own. accountId is opaque: key panels and subscriptions by it, never take it apart. clock says whether the revision is the account's own history ('engine') or trdrs reading a venue ('observation'). On an observation clock every read is a new reading and carries a new revision, so two reads of an account nothing happened to still differ: compare revisions, never count them. positionModel is 'net', so there is at most one signed position row per instrument.

accountId
string
required
revision
integer
required
clock
enum<string>
required
Available options:
engine,
observation
positionModel
enum<string>
required
Available options:
net
capabilities
object
required

WireAccountCapabilities (@trdrs/contracts): what the adapter behind this account implements, so a host renders only what the account supports rather than offering a control the venue will refuse. Every flag is about code that exists and is verified against the venue; anything unproven is false and the order path refuses it. A time-in-force absent from tifs is refused, never silently mapped to a different lifetime. This is not permission: whether the account may trade right now is the risk lock, which rides the stream's own lock channel.

connected
boolean
required
account
object
required
Example:
positions
object[]
required
orders
object[]
required
brackets
object[]
required
managedExits
object[]
required