For the complete documentation index, see llms.txt. This page is also available as Markdown.

List Currencies

Retrieves a list of available currencies with their details including exchange rates and currency types (fiat/crypto).

Endpoint

GET/v2/currency

Link

Request

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Accept

application/json

Yes


Response (200 OK)

Returns an array of currency objects with detailed information.

Response Fields

Currency Object

Field
Type
Description
Example

iso

string

ISO 4217 currency code (3-letter).

"USD"

name

string

Full currency name.

"US Dollar"

isCrypto

boolean

true for cryptocurrencies.

false

isDefault

boolean

true for system default currency.

true

rate

number

Exchange rate relative to default currency.

1.0

Example Response:

json


Error Responses

  1. Unauthorized:

    json


Notes

  • Rate Basis:

    • Exchange rates are relative to the default currency (e.g., isDefault: true).

    • Example: If USD is default, EUR rate 0.93 means 1 USD = 0.93 EUR.

  • Crypto Currencies:

    • Cryptocurrencies use standard ticker symbols (e.g., BTC, ETH).

    • Rates may update frequently due to market volatility.

  • Default Currency:

    • Typically used as the base for accounting and reporting.

    • Only one currency can be default per system.

Examples

Real request

Real response

200 OK

Last updated