Read the currency overview

Admin only. Returns the base currency, the staleness window in days, and the registry. The console reads it before a currency change, so both are set against the real values.

GET/api/v1/currency/overview

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Responses

200

Base currency, staleness window, and the active registry

base_currencystringrequired

rate_staleness_daysintegerrequired

min -9007199254740991 · max 9007199254740991

currenciesobject[]required

Show properties

Array of object

codestringrequired

namestringrequired

symbolstringrequired

exponentintegerrequired

min -9007199254740991 · max 9007199254740991

is_activebooleanrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Request

curl -X GET 'http://localhost:8000/api/v1/currency/overview' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/currency/overview", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/currency/overview",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "base_currency": "string",
  "rate_staleness_days": -9007199254740991,
  "currencies": [
    {
      "code": "string",
      "name": "string",
      "symbol": "string",
      "exponent": -9007199254740991,
      "is_active": true
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}