List investments

List every investment that you will encounter when importing a connection. This endpoint includes all the necessary information for you to correctly identify investments.

List investments for the given connection

Retrieve every investment for the given connection. It includes basic investment information

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

Authorization

bearerAuth

Path parameters

token*string

The external ID of the connections you want to fetch

Response

200401404500

Successfully retrieved all investments

Body

application/json

idstring (uuid)

UUID that uniquely identifies an investment

namestring

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

Example: "Apple Inc."

isinstring

The isin for the investment

Example: "ES0113900J37"

currencystring

The currency for the investment following the ISO 4217

Example: "EUR"

exchangestring

The stock exchange where the investment trades. Represented by its MIC code

Example: "BMEX"

assetTypestring

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

Example: "STOCK"

unknownboolean

If the investment could not be correctly identified, because information was not available at source. This typically means that the ISIN is missing

relatedSecuritystring (uuid)

Indicates if the security is related to another security in the connection. For example, rights will point to their underlying security

Request

JavaScriptCurlPythonHTTP

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

Response

200404

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Apple Inc.",
    "isin": "ES0113900J37",
    "currency": "EUR",
    "exchange": "BMEX",
    "assetType": "STOCK",
    "unknown": true,
    "relatedSecurity": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Dealing with unknown investments

Having unknown investments in your connection is something very unlikely and that can happen in a reduced number of entities. This typically happens because the entity does not directly offer the information, and we have to put in place other methods to identify the investment. Also, this information is typically missing for positions that are not active in the account.

We know that missing key information from an investment is a big problem when importing a connection. For that reason, we proactively complete missing information as soon as possible when we encounter an unknown investment. In that case, information for your connection will be automatically updated and you just need to query for investments again. If for some reason, an investment you need is missing key information after a day, contact us directly and we'll take care of it.