Skip to main content

Get Exchange Rates

Provide access to the latest EZ Rate (effective exchange rate) for supported currency pairs.

GET /v2/exchange-rates​

Request​

HTTP Headers​

To use this endpoint, the following headers are required for authentication:

HeaderTypeRequiredDescription
x-api-keyStringYesAPI key assigned to your account for accessing the service.
AuthorizationStringYesBearer token for authenticating the API request.

Query Parameters​

ParameterTypeRequiredDefaultDescription
pairsStringNoNoneComma-separated list of currency pairs to return. Each pair is 6 letters in BASEQUOTE ISO-4217 format (e.g., USDCAD,USDEUR,GBPEUR).
baseStringNoNoneFilter by base currency (ISO-4217), e.g., USD. Can be combined with quote. Ignored if pairs is provided.
quoteStringNoNoneFilter by quote currency (ISO-4217), e.g., CAD. Ignored if pairs is provided.

If no filters are provided, the endpoint returns all available pairs.

Example Requests​

GET /v2/exchange-rates HTTP/1.1
Host: api.example.com
Content-Type: application/json
x-api-key: <API_KEY>
Authorization: Bearer <BEARER_ACCESS_TOKEN>

Responses​

HTTP Status Codes​

Status CodeDescription
200OK
400Bad Request
401Unauthorized
500Internal Server Error

Schema​

PropertyTypeNullableDescription
requestIdStringNoUnique identifier assigned to each request for tracking purposes.
dataExchangeRatesPayloadNoExchange rate payload.

ExchangeRatesPayload​

PropertyTypeNullableDescription
updatedAtStringNoISO-8601 timestamp of the latest rate update (UTC).
productCurrenciesString[]NoPlatform-supported currencies (ISO-4217).
ratesExchangeRate[]NoList of EZ Rates for currency pairs.

ExchangeRate​

PropertyTypeNullableDescription
pairStringNoCurrency pair in BASEQUOTE format (e.g., USDCAD).
baseStringNoBase currency (ISO-4217).
quoteStringNoQuote currency (ISO-4217).
rateStringNoEZ Rate with 4 decimal places (e.g., "1.4102").

Only the EZ Rate is returned. Market rates and internal buffers are not exposed.

Example 200 OK Response​

{
"requestId": "b2b3f3c5-1e3a-4a3a-9df0-7b2f3c9b6b11",
"data": {
"updatedAt": "2025-10-03T04:00:07Z",
"productCurrencies": ["USD", "CAD", "EUR", "GBP"],
"rates": [
{ "pair": "USDCAD", "base": "USD", "quote": "CAD", "rate": "1.4102" },
{ "pair": "USDEUR", "base": "USD", "quote": "EUR", "rate": "0.8610" },
{ "pair": "USDGBP", "base": "USD", "quote": "GBP", "rate": "0.7506" },
{ "pair": "CADEUR", "base": "CAD", "quote": "EUR", "rate": "0.6166" },
{ "pair": "CADGBP", "base": "CAD", "quote": "GBP", "rate": "0.5376" },
{ "pair": "CADUSD", "base": "CAD", "quote": "USD", "rate": "0.7234" },
{ "pair": "EURCAD", "base": "EUR", "quote": "CAD", "rate": "1.6543" },
{ "pair": "EURGBP", "base": "EUR", "quote": "GBP", "rate": "0.8805" },
{ "pair": "EURUSD", "base": "EUR", "quote": "USD", "rate": "1.1848" },
{ "pair": "GBPCAD", "base": "GBP", "quote": "CAD", "rate": "1.8976" },
{ "pair": "GBPEUR", "base": "GBP", "quote": "EUR", "rate": "1.1586" },
{ "pair": "GBPUSD", "base": "GBP", "quote": "USD", "rate": "1.3591" }
]
}
}