This endpoint provides the entire universe of Clarity AI securities and provides a mapping of Clarity AI securities between different identifiers.
You can request the mapping by providing a list of PermIds in the permIds parameter or by providing a list of ISINs or
CUSIPs in the securityIds parameter, but you CANNOT SPECIFY BOTH permIds and securityIds.
If requesting CUSIPs via securityIds the securityIdsType needs to be set to “CUSIP”.
Leaving securityIds and permIds blank will return the whole Clarity AI universe.
The idColumns allows you to specify a list of security ID types that will be included in the response CSV. Only the
securities that have an identifier type matching idColumns will be returned. If you want to retrieve all the
securities, you can set idColumns to "ALL" and no securities will be filtered out.
Take into account that when using the "ALL" parameter whenever a new security identifier type is available in the Clarity AI
platform it will be included in the CSV response.
The securityTypes parameter allows you to specify which type of securities will be returned: “EQUITY”, “FIXED_INCOME”,
or “FUND”. You can specify multiple to receive multiple types or level blank to receive all available securities types.
The additionalOrganizationColumns allows you to specify a list of additional organization columns.
At the moment only ORGNAME and ORGCOUNTRY are supported.
The limitResults parameters allows you to limit the number of ISINS returned for each organization.
Please note: This endpoint returns only the identifier (UUID) for the created job. You'll need this UUID value to retrieve the status of your job (see Async Job - Get job status) or to download your file when ready (see Async Job - Download result file). See Async API documentation for a complete explanation of the flow for these async jobs endpoints.