# Instruments

An instrument is a tradable or holdable asset — bonds, stocks, FX
forwards, mutual funds, private market funds, loans, refunds, fees,
etc. Instruments are referenced by transactions, holdings, and
time-series data (prices, interest rates, index factors, NAVs).

## Endpoints

POST /v3/instruments
  Create a new instrument. Polymorphic — specify --type for the full schema.

GET /v3/instruments/:id
  Fetch one instrument.

DELETE /v3/instruments/:id
  Delete an instrument. Rejected if the instrument is referenced by
  any transaction or holding.

GET /v3/instruments/:id/private-instruments
  List the private instruments owned by the reporting entity given by `:id`.

GET /v3/instruments/:id/commitments
  List the commitments on a private-market fund instrument.

GET /v3/instruments/:id/commitments/:commitmentId
  Fetch one commitment.

GET /v3/instruments/:id/prices
POST /v3/instruments/:id/prices
  Price time series for an instrument. See `/v3/instruments/:id/prices`.

GET /v3/instruments/:id/interest-rates
POST /v3/instruments/:id/interest-rates
  Interest-rate time series for floating-rate / index-linked instruments.

GET /v3/instruments/:id/index-factors
POST /v3/instruments/:id/index-factors
  Index-factor time series for index-linked instruments.

GET /v3/instruments/:id/net-asset-values
POST /v3/instruments/:id/net-asset-values
  Net-asset-value time series, used for private-market funds.

DELETE /v3/instruments/:id/net-asset-values/:navId
  Delete one NAV observation by ID.

PATCH /v3/prices/:id
DELETE /v3/prices/:id
  Update or delete a specific price observation.

DELETE /v3/interest-rates/:id
  Delete a specific interest-rate observation.

DELETE /v3/index-factors/:id
  Delete a specific index-factor observation.

## Types (use `aleta api --spec POST /v3/instruments --type <type>`)

Createable:
  bond-instrument
  fx-forward-cash-settlement-instrument
  fx-forward-physical-delivery-instrument
  index-linked-bond-instrument
  loan-instrument
  mutual-fund-instrument
  private-market-fund-commitment-based-instrument
  stock-instrument
  zero-coupon-bond-instrument

Read-only / system-managed (returned by GET, not POSTable):
  fee-instrument
  refund-instrument
  other-instrument

## Common Attributes (most createable types)

  ccyCode             (string) — ISO 4217 currency. Examples: "USD", "EUR", "DKK".
  countryCode         (string) — ISO 3166-1 alpha-2 issuer domicile. Examples: "US", "DE", "DK".
  name                (string) — Display name.
  securityIdentifier  (string) — External security identifier (e.g. ISIN).

Type-specific attributes (couponFrequency, dayCountConvention,
maturityDate, interestRateInPercent, principalAmount, fund.* nested
objects, agreementDate, settlementAmount, etc.) live on each per-type
spec page.