List portfolio positions

Retrieves active positions for the given connection.

List active positions for the given connection

Retrieve every active position information for the given connection

GEThttps://api.finlink.vumi.io/api/v1/queries/connections/{token}/portfolios/active-positions

Authorization

bearerAuth

Path parameters

token*string

Token to identify the connection

Response

200401404500

Successfully retrieved all active positions

Body

application/json

portfoliostring (uuid)

Links the active position to a specific portfolio

investmentstring (uuid)

The investment reference for the active position. An ID that you can match with the List investments endpoint

namestring

The name for the investment. It typically depends on the data source

Example: "Banco Santander"

isinstring

The isin for the active position

Example: "ES0113900J37"

currencystring

The reference currency for the active position following the ISO 4217

Example: "EUR"

localCurrencystring

The local currency for the active position's investment following the ISO 4217

Example: "EUR"

exchangestring

The stock exchange where the active position's investment trades. Represented by its MIC code

Example: "BMEX"

assetTypestring

The active position's investment type. You can see available investments type in the Investments section of these docs

Example: "STOCK"

titlesnumber

The quantity of titles (shares, bonds, etc.) being held

amountnumber

The cash value for the active position given in the reference currency

localAmountnumber

The cash value for the active position given in the local currency

pricenumber

The current price per title of the active position given in the reference currency

localPricenumber

The current price per title of the active position given in the local currency

exchangeRatenumber

The exchange rate used for conversions is always provided from the reference currency to the local currency. For example, if the local currency is USD and the reference currency is EUR, the exchange rate given will be EURUSD

Example: 1.1809

weightnumber

The current weight of the active position in the portfolio per referency currency amount. Expressed on a per unit basis. Only investments are taken into account for this calculation (not cash positions)

Example: 0.45

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.finlink.vumi.io/api/v1/queries/connections/{token}/portfolios/active-positions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

[
  {
    "portfolio": "123e4567-e89b-12d3-a456-426614174000",
    "investment": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Banco Santander",
    "isin": "ES0113900J37",
    "currency": "EUR",
    "localCurrency": "EUR",
    "exchange": "BMEX",
    "assetType": "STOCK",
    "titles": 1,
    "amount": 1,
    "localAmount": 1,
    "price": 1,
    "localPrice": 1,
    "exchangeRate": 1.1809,
    "weight": 0.45
  }
]