External id systems

The identifier systems an asset is known by outside Aleta. The list is fixed and in priority order: the four securities identifiers, a custom identifier, and ticker and MIC, which name a listing only together. Use it to render an identifier picker or to know which ids carry a check digit.

Reads need the market_data:read scope.

Data model

idstring: The system's id. The same text as key.
keystring: isin, cins, cusip, figi, custom, ticker or mic.
namestring: Display name, e.g. ISIN.
examplestring: A valid id in the system.
checksumboolean: true when the id carries a check digit the API validates (isin, cins, cusip, figi).
paired_withstring or null: The system it names a listing with: mic for ticker and ticker for mic. null otherwise.

GET/v1/external-id-systems

List external id systems

Returns the seven systems in priority order, one page at a time. Pass limit (default 100, at most 1000) and the next_cursor of the previous page as cursor; next_cursor is null on the last page. The list does not change over time, so the page has no as_of.

Optional attributes

limitinteger: Page size. Default 100. A value below 1 is read as 1 and a value above 1000 as 1000; the response's limit is the size used.
cursorstring: The next_cursor of the previous page.

An unknown query parameter is a 400.

Errors

400 with code bad_request when limit is not a non-negative integer or cursor is not one this list issued (invalid cursor). 401 (unauthorized) without a valid token and 403 (forbidden) without the market_data:read scope.

Request

GET/v1/external-id-systems

curl https://api.aleta.ai/v1/external-id-systems \
  -H "Authorization: Bearer {access_token}"

Response

{
  "data": [
    { "id": "isin", "key": "isin", "name": "ISIN", "example": "US0378331005", "checksum": true, "paired_with": null },
    { "id": "cins", "key": "cins", "name": "CINS", "example": "G1151C101", "checksum": true, "paired_with": null },
    { "id": "cusip", "key": "cusip", "name": "CUSIP", "example": "037833100", "checksum": true, "paired_with": null },
    { "id": "figi", "key": "figi", "name": "FIGI", "example": "BBG000B9XRY4", "checksum": true, "paired_with": null },
    { "id": "custom", "key": "custom", "name": "Custom identifier", "example": "NDA-12345", "checksum": false, "paired_with": null },
    { "id": "ticker", "key": "ticker", "name": "Ticker", "example": "AAPL", "checksum": false, "paired_with": "mic" },
    { "id": "mic", "key": "mic", "name": "MIC", "example": "XNAS", "checksum": false, "paired_with": "ticker" }
  ],
  "next_cursor": null,
  "limit": 100
}