List portfolio transactions

Retrieves all the portfolio transactions for the given connection. Portfolio Transactions in Vumi Finlink are understood as those financial movements that are directly related to investments. Portfolio Transactions are related to a specific portfolio through its ID

List portfolio transactions for the given connection

Retrieve every portfolio transaction for the given connection

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

Authorization

bearerAuth

Path parameters

token*string

Token to identify the connection

Query parameters

Response

200401404500

Successfully retrieved all portfolio transactions

Body

application/json

itemsarray of TransactionDto (object)

List of items for the current page

limitinteger (int32)

Maximum number of items per page

pageinteger (int64)

Current page number starting from zero (0)

totalItemsinteger (int64)

Total number of items across all pages

Request

JavaScriptCurlPython

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

Response

200404

{
  "items": [
    {
      "transactionId": "123e4567-e89b-12d3-a456-426614174000",
      "portfolioId": "123e4567-e89b-12d3-a456-426614174000",
      "exchangeRate": 1.1809,
      "type": "BUY",
      "titles": 0,
      "amount": 1000,
      "amountBaseCurrency": 0,
      "commission": 0,
      "taxes": 0,
      "currency": "EUR",
      "localCurrency": "USD",
      "description": "text",
      "price": 0,
      "operationDateDay": "2024-10-04",
      "originalOperationDateDay": "2024-10-04",
      "valueDateDay": "2024-10-04",
      "originalValueDateDay": "2024-10-04",
      "operationDateHour": "text",
      "originalOperationDateHour": "text",
      "valueDateHour": "text",
      "originalValueDateHour": "text",
      "originalOperationDateTz": "text",
      "originalValueDateTz": "text",
      "investment": "123e4567-e89b-12d3-a456-426614174000",
      "relatedTransaction": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Portfolio transaction types

Understanding portfolio transaction types is core to using Vumi Finlink API correctly. These are the different types that you'll find:

Type	Description
BUY	Purchase of financial securities or assets
DELISTING	Removal of a security from a stock exchange
DIVIDENDS	Distribution of a portion of a company's earnings to shareholders
EXPIRATION
ISIN_CHANGE_BUY	Acquisition of securities as part of an isin change
ISIN_CHANGE_SELL	Sale of securities as part of an isin change
MERGER_BUY	Acquisition of securities as part of a merger
MERGER_SELL	Sale of securities as part of a merger
OFF_MARKET_BUY	Purchase of securities outside a formal exchange, or securities granted by an action not directly done by the holder
OFF_MARKET_SELL	Sale of securities outside a formal exchange, or due to an action not controlled by the holder
PRODUCT_CHANGE_BUY	Acquisition of securities as part of a product change. Product changes typically involve changing some aspects of the product, like the share class, without involving a full isin change
PRODUCT_CHANGE_SELL	Sale of securities as part of a product change. Product changes typically involve changing some aspects of the product, like the share class, without involving a full isin change
RIGHTS_EXCLUSION	Sell of rights typically due to their exclusion from the stock market
RIGHTS_ISSUE	Emission of rights, typically due to a Scrip dividend or capital raise
RIGHTS_CONVERSION	Conversion of rights into shares. This is the sell part associated to the rights
SCRIP_DIVIDEND	Receival of Stock as part of a scrip dividend. Typically associated to a RIGHTS_CONVERSON counterpart, but not always
SELL	Sale of financial securities or assets
SHARE_ISSUE_PREMIUM	Additional amount received over the par value of shares issued
SPINOFF	Grant of shares after the creation of an independent company from a parent company that is owned
SPLIT_BUY	Acquisition of securities as part of a split
SPLIT_SELL	Sale of securities as part of a split
TRANSFER_IN	Transfer of securities into an account
TRANSFER_OUT	Transfer of securities out of an account
UNKNOWN	Transactions that could not be correctly classified

Considerations

Handling unknown transactions