Currencies

Get currencies

get

Query parameters

CodestringOptional

The code of the currency.

NamestringOptional

The name of the currency.

NamePluralstringOptional

The plural name of the currency.

SymbolstringOptional

The symbol of the currency.

SymbolNativestringOptional

The native symbol of the currency.

DecimalDigitsinteger · int32Optional

The number of decimal digits for the currency.

Roundingnumber · doubleOptional

The rounding value for the currency.

TagsstringOptional

The tags for the currency.

IsCoinbooleanOptional

Flag to indicate if the currency is a coin.

KeywordsstringOptional

The keywords for the currency.

SortDataFieldstringOptional

The sort data field of the pagination.

SortOrderstringOptional

The sort order of the pagination.

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/currencies HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": null,
        "code": "USD",
        "name": "US Dollar",
        "namePlural": "US Dollars",
        "symbol": "$",
        "symbolNative": "$",
        "decimalDigits": 2,
        "rounding": 0.01,
        "isCoin": false,
        "isDefault": true
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}