Get the portfolio of an account

View your customers’ investment portfolios by retrieving their fund holdings, position details, and account balances for any account.

Getting Started

This guide walks you through retrieving portfolio information using the Rime API. You’ll make your first successful API call to access portfolio data and understand how to view your customers’ complete investment positions on your platform.

Prerequisites

Before retrieving portfolio information, ensure you have:

1. Authentication token - Follow our authentication guide to get your access token
2. Account information - The account_id for your customer’s portfolio you want to retrieve

Step-by-Step Implementation

Step 1: Get portfolio holdings for an account

Retrieve all holdings in a portfolio for a specific customer account using the account_id:

cURL

curl -X GET "https://sandbox.api.rime.finance/v1/accounts/${ACCOUNT_ID}/portfolio" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json"

Step 2: Handle the response

A successful portfolio retrieval returns a 200 OK status with an aggregated array of holdings:

200

{
  "data": [
    {
      "units_total": 120000,
      "units_redeemable": 70000,
      "units_locked": 50000,
      "isin": "NL1111111111",
      "breakdown": [
        {
          "locked_until": "2026-01-15",
          "units": 50000,
          "amount": 1278000,
          "created_at": "2024-01-15",
          "is_locked": true
        },
        {
          "locked_until": null,
          "units": 70000,
          "amount": 1789600,
          "created_at": "2024-03-15",
          "is_locked": false
        }
      ]
    },
    {
      "units_total": 80000,
      "units_redeemable": 0,
      "units_locked": 80000,
      "isin": "LU0987654321",
      "breakdown": [
        {
          "locked_until": "2025-12-31",
          "units": 80000,
          "amount": 2048000,
          "created_at": "2024-02-01",
          "is_locked": true
        }
      ]
    }
  ]
}

Portfolio Data Usage

Use the portfolio information to display your customers’ investment positions, calculate totals, and provide account statements for your platform.

Understanding Portfolio Structure

Portfolio Structure

The portfolio response contains aggregated holdings grouped by fund:

Fund Position (top level):

• units_total - Total number of fund shares held across all lock periods
• units_redeemable - Units currently available for redemption
• units_locked - Units currently in lock-up period
• isin - ISIN code identifying the specific fund investment
• breakdown - Array of individual holdings with lock period and monetary value details

Individual Holdings (within breakdown):

• units - The number of fund shares held for this specific holding
• amount - The monetary value of this holding in micro-units (1 EUR = 10,000 units)
• locked_until - Date when these specific units become available for trading (null if not locked)
• created_at - Date when this holding was created
• is_locked - Whether these units are currently locked from redemption

Troubleshooting

404 Not Found - Account Not Found

Cause: Invalid account_id or account has no portfolio holdings

Solution: Verify the account_id is correct and the account exists with holdings

{
  "detail": "Account not found or has no portfolio holdings"
}

403 Forbidden - Access Denied

Cause: Insufficient permissions to access the specified account’s portfolio

Solution: Ensure you have access to this account or verify the account belongs to your distributor organization.

{
  "detail": "Access denied to account portfolio"
}

422 Validation Error - Invalid Account ID

Cause: Malformed account_id parameter

Solution: Ensure the account_id is a valid UUID format

{
  "detail": [
    {
      "loc": ["path", "account_id"],
      "msg": "value is not a valid uuid",
      "type": "type_error.uuid"
    }
  ]
}

Next Steps

After retrieving portfolio information, you can:

1. Buy shares - Add new positions to your customers’ portfolios
2. Sell shares - Help your customers liquidate existing holdings
3. Retrieve fund information - Get details about funds in your customers’ portfolios

Ready to manage your customers’ investments? Use the portfolio data to provide comprehensive investment tracking and reporting for your platform.