Async Job - Request EU Tax Values for Securities

post

https://api.clarity.ai/clarity/v1/public/securities/eu-taxonomy/{objective}/metric-by-id/async

This endpoint will make a request to asynchronously retrieve extensive EU Tax information.

The asynchronous process will generate a file with EU Tax values for the whole universe of securities or a subset of it if a list of ISINs is included in 'securityIds' parameter.

These metrics are dependent on the objective and kpi passed in the request.
The metrics required must be added to 'metricIds' attribute. If left empty, all available metrics will be returned.
There is also additional information that can be requested using 'optionalColumns' parameter, like NFRD, DISCLOSURE (equities, fixed incomes), METRIC_YEAR, FLAG_SUSTAINABLE_BOND or GROUPED_NUCLEAR_FOSSILGAS aggregated values.

It is also possible to include sovereign bonds by setting the parameter 'includeSovereignBonds' to true.

Please note:

This call will only return the identifier (uuid) for this task. You'll need this value to:

Know the status of your job (see Async Job - Get job status)
Download your file when ready (see Async Job - Download compressed result file)

Please refer to Universe API's Technical documentation for a complete explanation of the workflow for these asynchronous job endpoints.

Path Params

objective

string

enum

required

EU Taxonomy objective. Allowed values: adaptation,aggregation,biodiversity,circular,mitigation,pollution,water

Allowed:

Query Params

headerPrefix

string

Adds a custom prefix to the exported column names

Body Params

metricIds

array of strings

Requested Metric IDs

metricIds

securityTypes

array of strings

enum

The security types requested. Allowed values: FUND, EQUITY, FIXED_INCOME

securityTypes

securityIds

array of strings

List of security ids (ISIN) to retrieve

securityIds

includeSovereignBonds

boolean

Include sovereign bonds

optionalColumns

array of strings

enum

Requested Optional columns. Allowed values: DISCLOSURE, NFRD, GROUPED_NUCLEAR_FOSSILGAS, METRIC_YEAR, FLAG_SUSTAINABLE_BOND.

optionalColumns

kpi

string

Requested Kpi. Allowed values: TURNOVER, CAPEX, OPEX

Responses

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The jobs request has been accepted, uuid follows

400Bad parameters on request: 2200 - The job was accepted but some error happened while processing 2006 - At least one of the scores requested does not exist or this account does not have permission to access it 7000 - Objective is not valid.

401Invalid grant: 1000 - Invalid authentication token or expired

403Forbidden: 1001 - This account does not have permission to access this resource