View as Markdown

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. The catalogue is read-only on v3; it's maintained by Aleta and shared across all workspaces.

Two flavours

The catalogue exposes a summary view (C1) and a detailed view (C2) of each class. The summary returns name, parent, and a few labels — enough to render breadcrumbs. The detailed view returns the full classification attributes: allowed transaction types, reporting conventions, parent C1 reference. Most dashboards only need the summary; the detailed shape exists for tooling that reasons about the taxonomy itself (limit editors, allocation breakdowns).

Data model

JSON:API resource type: instrument-class (summary) or instrument-class-detailed (full).

  • Name
    id
    Type
    string
    Description

    Stable class identifier.

  • Name
    name
    Type
    string
    Description

    Human-readable label shown in UIs.

Relationships

  • Name
    parent
    Type
    instrument-class
    Description

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

The detailed shape additionally exposes a parent relationship pointing at the C1 summary node, so a single fetch is enough to render an instrument's primary category alongside its detailed metadata.

GET/api/v3/instrument-classes/{id}

Retrieve a class

Summary shape (C1) — name, parent, basic metadata. All you need to label an instrument in a dashboard or breadcrumb.

Request

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

Retrieve a class (detailed)

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

Request

GET/api/v3/instrument-classes-detailed/{id}
curl https://platform.aleta.io/api/v3/instrument-classes-detailed/{id} \
  -H "Authorization: Bearer {access_token}"
  • Instruments — every instrument carries an instrumentClass relationship pointing into this taxonomy.
  • Time series — prices, NAVs, and rates hang off each instrument.
  • Limits (v2) — limit filters can target instrument-class paths.