Skip to navigation

Get a portfolio

Serves one portfolio 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 portfolio's row, rendered as the guide's Reads section describes: the position header and body field, the ETag, money as decimal strings.

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

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

namestring

Natural key — per-org unique among live portfolios.

orgIdinteger

Owner-stamped.

portfolioIdinteger
Sticky entity key.
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

Allowed values:
versionstringformat: "^-?[0-9]+$"

The row's version: monotonic per record, bumped on every change — served as the ETag and taken by If-Match. int64 as a decimal JSON string

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