View as Markdown

Currencies

Aleta's shared currency catalog: every currency a price, a rate or a cash account can be in. The list is platform data, read-only for a tenant.

Reads need the market_data:read scope.

Data model

codestring

The ISO 4217 code, e.g. DKK. Some codes outside ISO 4217 exist because bank files use them.

namestring or null

The currency's name as the legacy platform has it, e.g. Danish Krone. null when Aleta has no name for it.

numeric_codeinteger or null

The ISO 4217 numeric code.

kindstring

fiat, crypto, commodity, metal or custom.

decimalsinteger

The number of minor-unit digits (ISO 4217 exponent).

symbolstring or null

Display symbol, e.g. kr..

is_activeboolean

false for a currency no longer in use. Inactive currencies are in the list.

GET/v1/currencies

List currencies

Returns the whole catalog on one page in code order, inactive currencies included. next_cursor is always null and limit is the number of currencies. The list is not dated, so the page has no as_of.

Errors

401 without a valid token and 403 without the market_data:read scope.

Request
GET/v1/currencies
curl https://api.aleta.ai/v1/currencies \
  -H "Authorization: Bearer {access_token}"
Response
{
  "data": [
    {
      "code": "DKK",
      "name": "Danish Krone",
      "numeric_code": 208,
      "kind": "fiat",
      "decimals": 2,
      "symbol": "kr.",
      "is_active": true
    }
  ],
  "next_cursor": null,
  "limit": 1
}