Skip to content

List Exchange Rates

EndpointMethod
/api/admin/settings/exchange-ratesGET

Returns every exchange rate in the { data, meta } envelope. Each row carries its target currency's resolved targetCurrencyCode and targetCurrencyName inline, so no separate currency lookup is needed.

Pagination

ParameterDescription
pagePage number, 1-based. Default 1.
per_pageItems per page. Default 10, max 50.

Filters

Query parameters that narrow the result. Supplying more than one narrows further — they combine with logical AND.

ParameterMatchExample
target_currencyExact — target currency id.?target_currency=2
rate_fromMinimum rate, inclusive.?rate_from=0.5
rate_toMaximum rate, inclusive.?rate_to=2

rate_from and rate_to together bound the rate to a range.

Sorting

ParameterValues
sortid (default), target_currency, rate
orderasc, desc (default desc)

Both the compound form ?sort=rate-asc and the split form ?sort=rate&order=asc are accepted.

See the Exchange Rates overview for field meanings and behaviour.

Released under the MIT License.