CurrencyPair

Get currency pair by currency pair code

Returns currency pair information for a 6-character currency pair code (e.g., GBPUSD)

get/api-regulated/v1/currency-pairs/{currencyPair}

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/currency-pairs/{currencyPair}
  • Auth: HTTP bearer

Path parameters

currencyPairstring required

6-character currency pair code

Response

Successfully retrieved currency pair

currencyPairstring

6-character code for the currency pair

baseCurrencystring

Base currency code

quoteCurrencystring

Quote currency code

pipPrecisioninteger

Number of decimal places for pip precision

useFractionalPipsboolean

Whether this pair uses fractional pips

totalPrecisioninteger

Total precision including fractional pips

isActiveboolean

Whether this currency pair is active for trading

isMarketConventionboolean

Whether this pair follows market convention (true) or is inverted (false)

fwdRoute'DIRECT' | 'USD_CROSS' | 'EUR_CROSS'

How this pair's forward curve is obtained: DIRECT, or crossed from its two legs against USD or EUR.

volRoute'DIRECT' | 'USD_CROSS' | 'EUR_CROSS'

How this pair's volatility surface is obtained: DIRECT, or crossed from its two legs against USD or EUR.

historicDataSource'BOE' | 'FRED' | 'HKMA' | 'UNKNOWN'

External source that owns this pair's daily close price history.

calendarCodestring

Additional calendar code for settlement holidays (e.g., USNY for cross-currency pairs)

spotLagDaysinteger

FX spot settlement lag in business days (T+N). 2 for most pairs; 1 for USD T+1 pairs such as USDCAD, USDTRY, USDPHP, USDRUB. Drives value/settlement date derivation.

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

guardEnabledboolean

Whether CurrencyGuard sells Guards on this pair. A commercial decision, separate from is_active (live rates wanted) and from whether the pair can be priced (a vol surface route with a spread multiplier). New pairs default to false so offering one is deliberate.

Example response

{
  "currencyPair": "GBPUSD",
  "baseCurrency": "GBP",
  "quoteCurrency": "USD",
  "pipPrecision": 4,
  "useFractionalPips": true,
  "totalPrecision": 5,
  "isActive": true,
  "isMarketConvention": true,
  "fwdRoute": "DIRECT",
  "volRoute": "USD_CROSS",
  "historicDataSource": "BOE",
  "calendarCode": "USNY",
  "spotLagDays": 2,
  "eventSequence": 12345,
  "versionNumber": 1,
  "updatedBy": "jbloggs24",
  "updatedAt": "2024-10-18T12:30:40Z",
  "createdAt": "2024-10-18T12:30:40Z",
  "guardEnabled": true
}

Changes

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