Overview

Clarity AI provides API access to all of the modules it offers within the SaaS application along with datasets that are not available in the web application. These endpoints enable users to query scores, metrics, and values across the different endpoints on a number of different levels, e.g. fund, portfolio, security, or organization.

The API is organized around REST principles like resource-oriented URLs and uses standard HTTP features like response codes, verbs, and authentication. The API has been developed based on industry standards with a primary focus on secure connectivity and ease of use. It allows users to retrieve and integrate Clarity AI data into their own internal systems and custom applications. API access is granted on a per-user basis and once granted Keys and Secrets can be managed within the web application.

Clarity AI makes use of synchronous and asynchronous processes when responding to requests to varying endpoints. All requests to the Universe API endpoints are asynchronous.

Synchronous (Sync)

Synchronous endpoints return your results right away. With the synchronous API for a given portfolio, fund, or security you can retrieve a set of metrics / scores / attributes. With the result being returned right away in JSON format. With the synchronous endpoint you can do the following:

• Retrieve results for a portfolio
• Retrieve metrics / scores / attributes for portfolio, fund, security
• Retrieve data as a JSON response

Asynchronous (Async)

Asynchronous endpoints are also referred to as Universe endpoints. Asynchronous endpoints enable you to download the full Clarity AI universe for a given aggregation level (Security, Organization, Fund) as well as a subset of the universe for a given set of security IDs. The Asynchronous endpoint interaction occurs asynchronously, first, you request the data, then the API returns a JobID, after the job is complete you can download the result from the downloads endpoint based on the JobID. The endpoints return a CSV file or a compressed version of the CSV.
With the asynchronous endpoints you can do the following:

• Download full universe
• Download all metrics / scores / attributes (Note: This requires the right access, speak with your account manager)
• Download partial universe
• Download a partial set of metrics
• Download CSV response
• Download a compressed version of the response

Aggregation levels

Clarity AI API offers four different aggregation levels: Organization, Security, Portfolio, and Fund.

Organization Level

Organization endpoints provide data for the underlying entity for a given identifier.

Securities Level

Security endpoints provide data for a given security, either equity, fixed income, or fund for a given identifier.

Portfolio Level

Portfolio-level endpoints provide data for a given portfolio, which consists of weighted holdings. For some endpoints, portfolio-level aggregation occurs and returns the result for the whole portfolio.

Fund Level

Fund level endpoints are similar to the security level, except they only return data for securities that are fund.