Getting started with the Aumni API

Skip ahead to:

  1. The Problem: Limited access to quality investment data for advanced business analytics 
  2. The Solution: The Aumni API
  3. Accessing your Token and API documentation
  4. Filtering the API response for custom data sets using Aumni Presets
  5. Specifying different parameters for API endpoints
  6. Understanding default pagination and request send back 

I. The Problem

Limited access to quality investment data for advanced business analytics 

Portfolio and investment data housed in spreadsheets or contracts is critical information that is difficult to access and aggregate. Even if you have invested in technology to help manage this information at scale, it's likely legacy systems are outdated and incompatible with newer platforms, rendering them as inefficient as the data silos that occur in Excel and Google Sheets, or as PDFs stored within a file hosting application. Without accessible, high-fidelity data, it's near impossible to architect effective internal systems for analytics and other business needs, which exposes you to risk and missed opportunity. 

II. The Solution

The Aumni API

Aggregate your Aumni proprietary data with the other sources you care about via Aumni's read-only, RESTful API and get the comprehensive visibility needed to enhance reporting and portfolio analysis. The Aumni API programmatically extracts 250+ Report data points available in your preferred system to power your custom data workflows built for your business needs. The result is the highest-fidelity data available where and when you want it. 

In this article, you'll learn how to set up and access the Aumni API in your system, as well as understand any limitations. 

III. The Details

Accessing your Token and API documentation 

You can access our API documentation and token from your Settings, located within the side navigation panel from the Aumni platform. To get there, navigate to your User Menu (bottom left) > Settings > Organization (top right) > API Token. Within the body of that card, you'll also notice that there is a hyperlink to our documentation. 

Pro Tip: You do need to be logged into the dashboard to view this documentation — we put it behind an authentication layer because it allows you to try out the API using your account's token, and it also outlines the entire response, which is sensitive information.



Filtering the API response for custom datasets using Aumni Presets

Each endpoint has a parallel endpoint that allows you to specify a preset ID to customize your API output. It allows you to query the data for a custom report that you've already saved within the dashboard.

In order to achieve the filtering for specific funds in the endpoint, you can go into the Aumni UI > Reports > any report template that houses the dataset you're trying to get at. This will bring you to our Report Builder tool. You can then create your custom dataset by adding fields from the left side (if you only want to filter data, but still want all of the data points, add everything from the left and we will filter in the next step). Then click View Report.

Once you're in the report, use any of the column headers to dropdown and filter the data as you need. Then, click Save Report in the top right.


Once you save the report, you'll notice that the URL for the report now has a number at the end. This is the preset ID. You can use this preset ID in the API call for the particular report template endpoint that takes in a preset ID, and it will return only the data that was specified in that saved report.


If you ever wanted to expand the scope of that preset, you could go back into the saved report, change the data or filters, and overwrite the saved report.

Specifying different parameters for API endpoints

For any of the available endpoints in the Aumni API, you can specify queryparameters for pagination (page and results per page) and sort (by which key and in which direction).

The full list of queryparameters, along with the ability to test out the response for each endpoint, is available in our API documentation.


Understanding default pagination and request send back 

The Aumni API defaults to 1000 results per page if no other pagination is specified in the queryparameters. If your Aumni data set has more than 1000 results, you will need to utilize the pagination queryparameters to then iterate through the pages until there are no results in the response, indicating the end of the set. If your Aumni data set has less than 1000 results, you will hit zero results on the second iteration when querying with the pagination parameter of 2.

While there is currently no meta key that indicates how many total pages are present, we recommend that API users specify a page in the query and always iterate until no results are left in the response.




Articles in this section

Was this article helpful?
1 out of 1 found this helpful