Currency

Get currency

Fetches detailed information for a specific currency identified by its ISO code.

get/api-regulated/v1/currencies/{code}

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/currencies/{code}
  • Auth: HTTP bearer

Path parameters

codestring required

Currency code

Response

Currency retrieved

codestring

ISO 4217 currency code

descriptionstring

Description of the currency

precisioninteger

Precision of the currency (number of decimal places)

calendarCodestring

Industry standard calendar codes

isActiveboolean

Whether this currency is active. Tombstone flag: false = soft-deleted.

rateRoute'DIRECT' | 'FX_IMPLIED'

How this currency's discount factors are obtained: DIRECT from a bought curve, or FX_IMPLIED from the USD curve and forward points.

eventSequenceinteger

Event sequence number for event sourcing - globally monotonic across all entities

versionNumberinteger

Strictly monotonically increasing version number for this record

updatedBystring

Username of the person or entity that updated this record

updatedAtstring

Timestamp of the last update in UTC

createdAtstring

Timestamp of creation in UTC

Example response

{
  "code": "GBP",
  "description": "British Pound Sterling",
  "precision": 2,
  "calendarCode": "EUTA",
  "isActive": true,
  "rateRoute": "DIRECT",
  "eventSequence": 12345,
  "versionNumber": 1,
  "updatedBy": "jbloggs24",
  "updatedAt": "2024-10-18T12:30:40Z",
  "createdAt": "2024-10-18T12:30:40Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.