Instruments

An instrument is anything Aleta can hold a position in — a listed equity, a bond, a fund unit, an FX forward contract, an uncustodied private fund commitment. Every holding, transaction, and time-series in the platform points at an instrument. v3 renamed the family from "asset" to "instrument" in early 2026; the underlying catalog is the same.

Instrument types

The JSON:API type field on the resource tells you which shape to expect. Each type comes with its own attribute schema — bonds carry coupon and maturity, FX forwards carry near and far legs, private-market funds carry commitments.

Name
stock-instrument
Type
equity
Description
Listed equities. Carries ticker, exchange, ISIN, and listing currency.
Name
bond-instrument
Type
fixed income
Description
Standard coupon-bearing bonds. Carries coupon, maturity, and dayCountConvention.
Name
index-linked-bond-instrument
Type
fixed income
Description
Bonds whose principal accretes against an index — typically inflation.
Name
zero-coupon-bond-instrument
Type
fixed income
Description
Bonds with no periodic coupon. Same shape as a regular bond minus the coupon attribute.
Name
mutual-fund-instrument
Type
fund
Description
Open-ended mutual funds and UCITS structures. Valued via NAV.
Name
loan-instrument
Type
fixed income
Description
Direct loans booked on the platform.
Name
fee-instrument
Type
flow
Description
Synthetic instrument used to model running fee accruals against a portfolio.
Name
other-instrument
Type
catch-all
Description
Any holding that doesn't fit a specific type. Carries free-form metadata only.
Name
fx-forward-cash-settlement-contract
Type
derivative
Description
Cash-settled FX forward. Carries near and far legs, settlement date, and the contracted forward rate.
Name
fx-forward-physical-delivery-contract
Type
derivative
Description
Physical-delivery FX forward — same shape, different settlement.
Name
private-market-fund
Type
private markets
Description
PE / private market vehicles. Carries commitment data and the call/distribution schedule.

Common attributes

Every instrument resource carries:

Name
id
Type
string
Description
Stable identifier. 24-character hex for legacy compatibility — treat as opaque.
Name
name
Type
string
Description
Display name shown in the product.
Name
externalIdentifier
Type
string
Description
External reference — typically an ISIN, CUSIP, or the originating custodian's identifier. Not unique across instrument types.

Relationships

Name
instrumentClass
Type
instrument-class
Description
The taxonomy node this instrument belongs to. Drives transaction typing, allocation roll-ups, and limit scoping. See Instrument classes.

GET/api/v3/instruments/{id}

Retrieve an instrument

Single-instrument lookup. The response includes every attribute specific to the instrument's type — bonds will have coupon and maturity, FX forwards will have leg detail, etc.

Request

GET/api/v3/instruments/{id}

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

POST/api/v3/instruments

Create an instrument

Adds an instrument to the catalog. Choose the right type up front — the platform validates the payload against that type's schema and rejects mismatched fields. For private-market vehicles scoped to a single reporting entity, use the private instruments sub-resource instead.

Request

POST/api/v3/instruments

curl -X POST https://platform.aleta.io/api/v3/instruments \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
    "data": {
      "type": "bond-instrument",
      "attributes": {
        "name": "Republic of Denmark 0.50% 2030",
        "externalIdentifier": "DK0009923757",
        "coupon": 0.005,
        "maturity": "2030-11-15",
        "dayCountConvention": "ACT/ACT"
      }
    }
  }'

DELETE/api/v3/instruments/{id}

Delete an instrument

Removes an instrument from the catalog. Allowed only when no holdings or transactions still reference it.

Request

DELETE/api/v3/instruments/{id}

curl -X DELETE https://platform.aleta.io/api/v3/instruments/{id} \
  -H "Authorization: Bearer {access_token}"

GET/api/v3/instruments/{reportingEntityId}/private-instruments

List private instruments

Private instruments are scoped to a single reporting entity rather than shared across the workspace — uncustodied funds, club deals, family-only vehicles. This endpoint returns the private-instrument catalog visible inside one reporting entity.

Request

GET/api/v3/instruments/{reportingEntityId}/private-instruments

curl https://platform.aleta.io/api/v3/instruments/{reporting_entity_id}/private-instruments \
  -H "Authorization: Bearer {access_token}"

POST/api/v3/instruments/{reportingEntityId}/private-instruments

Create a private instrument

Creates a private instrument scoped to the reporting entity. Same type discriminator as the public catalog — typically private-market-fund for PE vehicles.

Request

POST/api/v3/instruments/{reportingEntityId}/private-instruments

curl -X POST https://platform.aleta.io/api/v3/instruments/{reporting_entity_id}/private-instruments \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/vnd.api+json" \
  -d '{
    "data": {
      "type": "private-market-fund",
      "attributes": {
        "name": "Andersen Family Co-invest 2024",
        "commitment": 5000000,
        "ccyCode": "EUR"
      }
    }
  }'

Instrument classes — the taxonomy each instrument belongs to.
Time series — prices, NAVs, rates, and index factors per instrument.
Holdings — what positions in these instruments look like at the reporting-entity level.