List the currency registry

Any signed in user. Returns every currency the register can format money in. Pass include_inactive=true to include deactivated ones the console still replays.

GET/api/v1/currency

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Query parameters

include_inactiveboolean

Include deactivated currencies. The route matches the literal string true, on its own.

Responses

200

The registry

itemsobject[]required

Show properties

Array of object

codestringrequired

namestringrequired

symbolstringrequired

exponentintegerrequired

min -9007199254740991 · max 9007199254740991

is_activebooleanrequired

401

Not authenticated

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

Parameters

include_inactivequeryInclude deactivated currencies. The route matches the literal string true, on its own.

Request

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

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

import requests

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

Response

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

{
  "detail": "string"
}