VUMI Documentation
  • Introduction
    • 🎉Welcome!
    • ➡️Quick Start
  • Platform
    • App Overview
      • API Products
      • Connections Overview
      • API Configuration
    • Link Overview
      • Link redirects
      • Link parameters
      • Customization
  • General API Resources
    • Authentication
      • API Login
      • Link authentication
    • Entities
      • List entities for app
    • Connections
      • Exchange public token
      • Get Connection status
      • List all connections
      • List public tokens
      • Delete Connection
    • Investments
      • List investments
    • Webhook
      • Get verification key
  • Aggregation API
    • Accounts
      • List accounts
      • List account transactions
    • Portfolios
      • List portfolios
      • List portfolio transactions
      • List portfolio positions
  • Assets Transfer API
    • Assets transfer
  • Developer Resources
    • API and Widget Errors
    • Webhooks and security
      • Webhook verification
    • Pagination
    • Tracing requests
Powered by GitBook
On this page
  1. Aggregation API
  2. Portfolios

List portfolio positions

Last updated 1 day ago

Retrieves active investment positions held within the portfolios of the given connection. It includes the necessary information to obtain a full picture of the portfolio positions and valuation. Cash positions are not included here and, if applicable (like in BROKER entities), they can be obtained from the balance of the .

List accounts endpoint

List active positions for the given connection

get

Retrieve every active position information for the given connection

Authorizations
Path parameters
tokenstringRequired

Token to identify the connection

Responses
200
Successfully retrieved all active positions
application/json
401
Invalid credentials
application/json
404
Connection not found with the given token for the current app
application/json
500
Internal server error
application/json
get
GET /api/v1/queries/connections/{token}/portfolios/active-positions HTTP/1.1
Host: api.finlink.vumi.io
Authorization: Bearer JWT
Accept: */*
[
  {
    "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
  }
]