Query Rates

Retrieves real-time exchange rates for one or more currency pairs. You can specify either the sell amount or the buy amount to get the corresponding rate. An optional settlement date can be provided to retrieve rates for a specific value date.
Request Parameters
rateConditionsarray
required
List of exchange rate query conditions. Supports up to 100 elements.
Show child parametersShow child parameters
settlementDatestring
Settlement date for the exchange rate, in YYYY-MM-DD format (UTC). Fixed length of 10 characters. Use this to retrieve a rate for a specific value date.
Response Parameters
resultResult
See Result.
settlementDatestring
Settlement date, in YYYY-MM-DD format (UTC). Fixed length of 10 characters. Returned when settlementDate is provided in the request.
rateDetailsarray
List of rate query results. Up to 100 elements.
Show child parametersShow child parameters
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSsuccessN/A
CURRENCY_NOT_SUPPORTEDFThe specified currency is not supported.Use a supported currency code following the ISO 4217 standard. See [Data Types](https://docs.worldfirst.com/wfdocs/api-sdk/data_types)
FX_SETTLEMENT_DATE_NOT_SUPPORTEDFThe settlement date is not supported for this currency pair.Choose a valid settlement date supported by the currency pair.
FX_CURRENCY_PAIR_RISK_BREAKFThe currency pair has triggered risk control.Contact support to review risk control limits for this currency pair.
Definition
POST /api/open/v1/fx/rates/query
Request
{
"rateConditions": [
  {
    "sellAmount": {
      "currency": "USD",
      "value": 10000
    },
    "buyAmount": {
      "currency": "HKD"
    }
  }
]
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"rateDetails": [
  {
    "sellAmount": {
      "currency": "USD",
      "value": 10000
    },
    "buyAmount": {
      "currency": "HKD",
      "value": 77850
    },
    "clientRate": 7.785,
    "createdAt": "2026-04-02T12:08:56Z"
  }
]
}