Skip to main content
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 -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": 120000,
      "isin": "NL1111111111",
      "holdings": [
        {
          "locked_until": "2026-01-15",
          "units": 50000
        },
        {
          "locked_until": "2026-03-15",
          "units": 70000
        }
      ]
    },
    {
      "units": 80000,
      "isin": "LU0987654321",
      "holdings": [
        {
          "locked_until": "2025-12-31",
          "units": 80000
        }
      ]
    }
  ]
}

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 and lock period: Fund Position (top level):
  • units - Total number of fund shares held across all lock periods
  • isin - ISIN code identifying the specific fund investment
  • holdings - Array of individual holdings with different lock periods
Individual Holdings (within each position):
  • units - The number of fund shares held for this specific lock period
  • locked_until - Date when these specific units become available for trading
Assets with the same isin and locked_until date are automatically aggregated together.

​
Troubleshooting

Cause: Invalid account_id or account has no portfolio holdingsSolution: Verify the account_id is correct and the account exists with holdings
{
  "detail": "Account not found or has no portfolio holdings"
}
Cause: Insufficient permissions to access the specified account’s portfolioSolution: Ensure you have access to this account or verify the account belongs to your distributor organization.
{
  "detail": "Access denied to account portfolio"
}
Cause: Malformed account_id parameterSolution: 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.
⌘I