List portfolios

Returns the list of every portfolio found in a connection, including inactive portfolios.

List portfolios for the given connection

Retrieve every portfolio for the given connection

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

Authorization

bearerAuth

Path parameters

token*string

Token to identify the connection

Response

200401404500

Successfully retrieved all portfolios

Body

application/json

idstring (uuid)

The portfolio ID

typeenum

The portfolio type

STOCK_PORTFOLIOCOMPOSITE_ASSETS_PORTFOLIOMIX

ownersarray of string

A list of unique portfolio owners

balancenumber

The portfolio balance at the updatedAt timestamp

currencystring

The portfolio base currency following the ISO 4217

Example: "EUR"

createdAtstring (date-time)

Timestamp in UTC at which the portfolio was created

updatedAtstring (date-time)

Timestamp in UTC at which the portfolio information was last updated

Request

JavaScriptCurlPython

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

Response

200404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "STOCK_PORTFOLIO",
    "owners": [
      "CARLOS MATA GARCIA",
      "OSCAR MENDEZ VALLADARES"
    ],
    "balance": 0,
    "currency": "EUR",
    "createdAt": "2024-10-16T00:21:49.485Z",
    "updatedAt": "2024-10-16T00:21:49.485Z"
  }
]

Portfolio types

You will find the following portfolio types when using our API:

Type	Description
MIX	A portfolio with investments of multiple types inside it
STOCK_PORTFOLIO	A portfolio that only invests in stock-related securities, such as stocks, ETFs, CFDs, ... It doesn't hold any FUNDs or Pension Plans
COMPOSITE_ASSETS_PORTFOLIO	A portfolio that only holds investments in Funds or Pension Plans