Universe API

Retrieve investment identifiers in your entitled universe.

Getting Started

View MarkdownDownload Markdown

The Universe API returns the investments in your entitled universe, with the performance IDs that other APIs use to identify them. This guide covers the workflow for making your first call and where to go when something goes wrong.

Workflow

1

Get an access token

The API uses OAuth 2.0 to authenticate users. Before you can call any endpoint, you must authenticate your account and get an access token.

See the Authentication article for information about obtaining and using access tokens.

2

Find your entitlements

Send a request with no filters. The response doesn't list investments. It lists the exchanges, countries and domiciles you are entitled to, which are the values you can use as the primary filter. Use the source parameter to choose equities or managed investments.

See Get Your Universe for how to make the request.

3

Filter the universe

Choose a primary filter, such as an exchange for equities or a country for managed investments, to list the investments in that part of your universe. You can narrow the results further with secondary filters, or retrieve a custom universe that was set up for your account.

See Get Your Universe for the filters, and Filter Values for the accepted values.

4

Page through the results

Each response contains up to 50 investments. If more are available, the response includes a pagination token. Pass the token in your next request, with the same filters, and repeat until no token is returned.

See Work with Results for how to read the response and use the tokens.

5

Use the performance IDs

Every investment in the response has an identifier that you can store and pass to other APIs, such as the Investment Details API, the Investment List API and the Time Series API.

See the Identifiers article for the identifiers the APIs support.

Steps 1 and 2 are setup. You repeat step 1 only when your access token expires, and step 2 only if your entitlements change. Steps 3 through 5 are repeated whenever you refresh your list of investments.

Managing Issues

If a request fails or returns unexpected results:

  • Check the Error Messages page to find out what an error code or message means.
  • See Troubleshooting for help with common issues, such as an empty list of investments or filters that aren't accepted.
  • Browse the FAQs for answers to frequently asked questions.