Core Concepts

The Universe API returns the investments in your entitled universe. This page introduces the key ideas, and links to the articles that explain each one in detail.

Your Entitled Universe

Your entitled universe is the set of investments that your account is licensed to use. What the API returns depends on your entitlements, and so do the filters you can apply. A request with no filters tells you which exchanges, countries and domiciles you are entitled to.

• Get Your Universe explains how to find your entitlements.

Custom Universes

A custom universe is a named subset of your entitled universe, set up for your account. You can retrieve it in full, or narrow it further with filters.

• Get Your Universe explains how to retrieve a custom universe.

Primary and Secondary Filters

A primary filter sets the top-level scope of the results. It is required, and a request can have only one. For equities it is the exchange, and for managed investments it is the country available for sale or the domicile. Secondary filters are optional, and narrow the results within the scope that the primary filter sets.

• Get Your Universe explains how to use the filters.
• Filter Values lists the accepted values.

Pagination

Responses contain up to 50 investments. When there are more, the response includes a token that you pass in your next request to get the next page. You stop when there is no token.

• Work with Results explains how to use pagination tokens.