Instrument classes

Every instrument Aleta knows about is tagged with an instrument class. The class drives transaction typing, allocation roll-ups, and limit scoping — "don't go above 5% in any single hedge fund" is enforceable because the platform knows which instruments are hedge funds.

Two flavours

The catalogue exposes a summary view and a detailed view of each class.

  • /v2/instrument-classes/{id} — name, parent, quick metadata. Use when you only need the label.
  • /v2/instrument-classes-detailed/{id} — the full definition including classification attributes, allowed transaction types, and reporting conventions. Use when you're building allocation tooling or a limit editor.

Most dashboards only need the summary shape; the detailed shape exists for tooling that reasons about the taxonomy itself.

Data model

  • Name
    id
    Type
    string
    Description

    Stable class identifier.

  • Name
    name
    Type
    string
    Description

    Human-readable label shown in UIs.

  • Name
    parent_id
    Type
    string | null
    Description

    Classes form a tree — "Listed equity" has children "Developed markets" and "Emerging markets," and so on. The root has no parent.

  • Name
    path
    Type
    array of strings
    Description

    Convenience field — the full ancestor chain, root-first. Useful for breadcrumb rendering without an extra fetch.

GET/v2/instrument-classes/{id}

Retrieve a class

Summary shape — name, parent, path. All you need to label an instrument in a dashboard or breadcrumb.

Request

GET
/v2/instrument-classes/{id}
curl https://api.aleta.io/v2/instrument-classes/{id} \
  -H "Authorization: Bearer {token}"
GET/v2/instrument-classes-detailed/{id}

Retrieve a class (detailed)

Detailed shape — classification attributes, allowed transaction types, reporting conventions. Reach for this when you're building tooling that reasons about the taxonomy itself (limit editors, allocation breakdowns).

Request

GET
/v2/instrument-classes-detailed/{id}
curl https://api.aleta.io/v2/instrument-classes-detailed/{id} \
  -H "Authorization: Bearer {token}"
  • Time series — prices, NAVs, and rates hang off each instrument.
  • Transactions — typed per instrument class.
  • Limits — can filter on instrument classes.