Find exchange rates

GET

/config/currency/exchange-rates

Required scope: exchangerate:read

Finds exchange rates. A rate is valid from its start date until the next rate of the pair starts, or forever if no later rate exists, so rates of a pair never overlap and leave no gaps. By default it returns the rates that are valid on a date, one per currency pair, which is the rate with the latest start date on or before the date. With allDates set to true it returns every stored rate of the matching pairs regardless of date, which gives the history of a pair when combined with sourceCurrencyCodes and targetCurrencyCodes. Pairs with a currency without a code are left out. Pairs with an inactive currency are left out, unless the inactive currency is named in sourceCurrencyCodes (for the source) or targetCurrencyCodes (for the target). The end date of a rate is derived and read-only: the day before the next rate of the pair starts, or null if no later rate exists. Results are sorted by source currency code, then by target currency code, then by start date with the latest first.

Parameters

Query parameters

page  integer

The page number to retrieve. The first page is 1. Cannot be less than 1.

Default value: 1

pageSize  integer

The size of the pages to retrieve. The default is 10. Cannot be less than 1 and larger than 100.

Default value: 10

sourceCurrencyCodes  string

Multivalued

Only return rates from these source currencies, given by their three letter ISO codes. Case-insensitive. Codes that match no currency are ignored. A source currency named here is included even if it is inactive. Omit to return all active source currencies.

targetCurrencyCodes  string

Multivalued

Only return rates to these target currencies, given by their three letter ISO codes. Case-insensitive. Codes that match no currency are ignored. A target currency named here is included even if it is inactive. Omit to return all active target currencies.

date  string

Only return the rates that are valid on this date. Defaults to today. Cannot be combined with allDates set to true.

allDates  boolean

Whether to return every stored rate of the matching currency pairs regardless of date, instead of one rate per pair that is valid on a date. Cannot be combined with date.

Default value: false

Response

The response contains the found exchange rates.