Endpoints

Async Job, get Carbon Footprint Security metric values

post
https://api.clarity.ai/clarity/v1/public/securities/climate/carbon-footprint/metric-by-id/async

This endpoint will make a request for an async Job to retrieve the whole universe of Clarity.AI Carbon footprint for given metrics ids.
Please note: This call will only return the identifier (uuid) for this task. You'll need this value later on further calls to know the status of your job (see Async Job - Get job status) or download your file when ready (see «Async Job - Download result file»)
Check this document for a complete explanation of the flow for these Async jobs endpoints

Body Params
idColumns
array of strings
enum

Requested Footprint Security Id columns show in result file

idColumns
metricIds
array of strings

Requested Footprint Security Metric IDs

metricIds
securityTypes
array of strings
enum

Requested Footprint Security Types

securityTypes
string
enum

Requested Footprint Security Id Type

Allowed:
securityIds
array of strings

Requested Footprint Security Ids

securityIds
Responses

Updated 2 minutes ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 minutes ago