Universe API
Retrieve investment identifiers in your entitled universe.
Universe API
The Universe API is a utility that returns the investments in your entitled universe. Use it to find out what you are entitled to, to list the investments in a universe or a part of it, and to get the performance IDs that other APIs need. The API covers equities and managed investments.
New to the API? Start with Getting Started.
At a Glance
| Feature | Details |
|---|---|
| Purpose | Retrieve your entitled universe and the performance IDs of its investments. |
| Investments | Equities and managed investments. |
| Endpoint | One GET endpoint. |
| Filters | A primary filter, such as an exchange or a country, and optional secondary filters. |
| Results per page | Up to 50, with token-based pagination. |
| Authentication | OAuth 2.0 access token, valid for 60 minutes. |
Key Capabilities
- Find out which exchanges, countries and domiciles you are entitled to.
- List the investments in your entitled universe, filtered by a primary filter and optional secondary filters.
- Retrieve a custom universe, which is a named subset of your entitled universe.
- Page through large universes with pagination tokens.
- Get the performance ID of every investment, to use as the identifier in other APIs.
How It Works
- Find your entitlements. Send a request with no filters to see the primary filters you can use.
- Filter the universe. Choose a primary filter, and optionally secondary filters, or a custom universe.
- Page through the results. Use the pagination token in each response to get the next page, and stop when there isn't one.
- Use the performance IDs. Store them, and pass them to other APIs.
In This Guide
| Section | What You'll Find |
|---|---|
| Getting Started | The workflow for making your first call. |
| Core Concepts | Entitlements, custom universes, filters and pagination. |
| Get Your Universe | Get entitlements, filter the universe and use a custom universe. |
| Work with Results | Read the response and page through the results. |
| Quick Lookup | Reference for API Inputs, Filter Values and Error Messages. |
| FAQs | Answers to common questions. |
| Troubleshooting | Fixes for common problems. |
Related APIs
The Universe API gives you the performance IDs that these APIs use as their primary identifier.
- Investment Details API and Investment Details Feed API for detailed investment data.
- Investment List API for tabular, list-based data.
- Time Series API for historical data.
- Screener APIs to find investments by criteria.