Portfolios

One portfolio, priced. Open lots are rolled up into a position per instrument, each marked from its own price lane and labelled with the trading session that mark belongs to; a position that could not be priced carries nulls and a reason rather than a zero. Closed lots are listed with their realized profit and loss, and instruments watched but not held come in a separate `watching` array carrying marks only, outside every total. Totals are in the portfolio's `currency`; each position and lot states its own currency, with its figures converted at the official rates listed in `conversionRates`.

get/v1/portfolios/{id}

Request

Path parameters

idstring uuid required

The portfolio's id, from your list or the shared list.

Response

OK

idstring uuid
namestring nullable
accessstring nullable

What you may do with it: Owner, Edit (change its lots and watches) or View.

sharedBystring nullable

Who shared it with your organization. Absent on your own portfolios.

asOfUtcstring date-time

When this valuation was computed, UTC.

currencystring nullable

ISO 4217 code every total below is stated in.

costBasisnumber double

Total paid across every open lot whose cost converts into currency, priced or not.

marketValuenumber double nullable

Sum over the positions that could be priced. Null when none could.

unrealizedGainnumber double nullable
unrealizedGainPercentnumber double nullable
realizedGainnumber double

Profit or loss already taken, across every closed lot.

unconvertedClosedLotCountinteger

Closed lots left out of realizedGain because no rate converts them.

unvaluedPositionCountinteger

Open positions this pass could not price. Never silently excluded: a total computed over part of a portfolio reads as the whole one unless the gap is stated.

unconvertedPositionCountinteger

Open positions left out of the totals because their cost or value could not be converted into currency; each says why in conversionUnavailableReason.

coverageNotestring nullable

Set when a bound stopped this pass from pricing everything, for example more distinct option contracts than one valuation may fetch. Null when nothing was cut.

Changes

No recorded changes to this operation across all 1 revision of this API.