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:
| Header | Type | Required | Description |
|---|---|---|---|
x-api-key | String | Yes | API key assigned to your account for accessing the service. |
Authorization | String | Yes | Bearer token for authenticating the API request. |
Query Parameters​
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pairs | String | No | None | Comma-separated list of currency pairs to return. Each pair is 6 letters in BASEQUOTE ISO-4217 format (e.g., USDCAD,USDEUR,GBPEUR). |
base | String | No | None | Filter by base currency (ISO-4217), e.g., USD. Can be combined with quote. Ignored if pairs is provided. |
quote | String | No | None | Filter 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 Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Internal Server Error |
Schema​
| Property | Type | Nullable | Description |
|---|---|---|---|
| requestId | String | No | Unique identifier assigned to each request for tracking purposes. |
| data | ExchangeRatesPayload | No | Exchange rate payload. |
ExchangeRatesPayload​
| Property | Type | Nullable | Description |
|---|---|---|---|
| updatedAt | String | No | ISO-8601 timestamp of the latest rate update (UTC). |
| productCurrencies | String[] | No | Platform-supported currencies (ISO-4217). |
| rates | ExchangeRate[] | No | List of EZ Rates for currency pairs. |
ExchangeRate​
| Property | Type | Nullable | Description |
|---|---|---|---|
| pair | String | No | Currency pair in BASEQUOTE format (e.g., USDCAD). |
| base | String | No | Base currency (ISO-4217). |
| quote | String | No | Quote currency (ISO-4217). |
| rate | String | No | EZ 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" }
]
}
}