v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB

Investments

Get position

Retrieve a specific position.

get/financial-data/v2beta/portfolios/{pid}/holdings/{hid}/positions/{id}

Path parameters

pidstring required

Example:654d7617-1cd3-46ab-921a-56fd92acf4a4

ID of the portfolio which the holding is associated with.

hidstring required

Example:b1c629e2-6463-4c76-9ddc-58aab54340c3

The ID of the holding.

idstring required

The ID of the position.

Response

A position.

idstring required

Unique resource identifier.

holdingIdstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

timestampstring date-time required

Timestamp of when the position was recorded. This timestamp is reported in UTC and thus the date component of this timestamp may be different than localDate.

localDatestring date required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

maturityDatestring date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

The type of holding.

sharesnumber double

Number of shares held

yieldnumber double

Annualized yield of the fund

wamnumber double

Weighted Average Maturity in days

walnumber double

Weighted Average Life in days

wlanumber double

Weekly Liquid Assets (%)

ratenumber double

Bond coupon rate expressed as a decimal fraction, e.g. 0.0425 for 4.25%

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "holdingId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "timestamp": "2023-04-25T15:01:13.738861011Z",
  "localDate": "2022-05-07",
  "maturityDate": "2022-05-07",
  "type": "MONEY_MARKET_FUND",
  "nav": {
    "currency": "EUR",
    "stringValue": "15.02",
    "value": 1502
  },
  "scaledNav": {
    "currency": "EUR"
  },
  "totalValue": {
    "currency": "EUR",
    "stringValue": "15.02",
    "value": 1502
  },
  "nominal": {
    "currency": "EUR",
    "stringValue": "15.02",
    "value": 1502
  },
  "fundAum": {
    "currency": "EUR",
    "stringValue": "15.02",
    "value": 1502
  },
  "totalPurchasePrice": {
    "currency": "EUR",
    "stringValue": "15.02",
    "value": 1502
  },
  "version": 1,
  "etag": "version:3"
}