Getting Started
This guide walks you through retrieving fund information using the Rime API. You’ll make your first successful API call to access fund data and understand how to filter and explore available investment options for your distributor platform.Prerequisites
Before retrieving fund information, ensure you have:- Authentication token - Follow our authentication guide to get your access token
- Basic understanding of fund concepts - ISINs, share classes, and trading flags
Step-by-Step Implementation
Step 1: List all available funds
Start by retrieving a list of all available funds to explore investment options for your distributor platform:Step 2: Get information on a specific fund
Retrieve comprehensive information about a specific fund using itsabbreviation
:
Step 3: Handle the response
A successful fund data retrieval returns a200 OK
status with detailed fund information:
200
Filtering funds by criteria
Narrow down your search using specific criteria like fund properties:Troubleshooting
404 Not Found - Fund Not Found
404 Not Found - Fund Not Found
Cause: Invalid
isin
or fund doesn’t existSolution: Verify the isin
by listing available funds first401 Unauthorized - Invalid Token
401 Unauthorized - Invalid Token
422 Validation Error - Invalid Parameters
422 Validation Error - Invalid Parameters
Cause: Invalid query parameters or incorrect data typesSolution: Check parameter types and ensure boolean values are properly formatted
Next Steps
After retrieving fund information, you can:- Get portfolio information - View existing fund holdings and account balances
- Buy shares - Purchase fund units for your accounts
- Sell shares - Sell existing fund holdings