---
canonical_url: "https://docs.composio.dev/toolkits/currencyapi"
markdown_url: "https://docs.composio.dev/toolkits/currencyapi.md"
product: "platform"
version: null
last_updated: null
---

# Currencyapi

Currencyapi provides current, historical, and official exchange rates plus currency and country metadata.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 15
- **Triggers:** 0
- **Slug:** `CURRENCYAPI`
- **Version:** 00000000_00

## Tools

### Compare Official Rates

**Slug:** `CURRENCYAPI_COMPARE_OFFICIAL_RATES`

Compare one currency pair across selected or all available central-bank sources for a requested date, or across their newest publications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Requested comparison date in YYYY-MM-DD form; omit for current official publications. |
| `sources` | array | No | Central-bank source codes to compare; omit to use every applicable source. |
| `currency` | string | Yes | Three-letter quote currency to compare against the base currency. |
| `base_currency` | string | Yes | Three-letter base currency for the comparison. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Amounts

**Slug:** `CURRENCYAPI_CONVERT_AMOUNTS`

Convert one amount or up to 100 amounts from a base currency into selected currencies, optionally using historical rates, retail rounding, and locale formatting. The endpoint requires a paid Small+ plan. datetime has an additional update-tier requirement: Small provides hourly, Pro quarter-hourly, and Medium-or-higher minute intraday rates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Past UTC date in YYYY-MM-DD form for daily historical rates; mutually exclusive with datetime. Omit both for latest rates. |
| `shape` | string ("default" | "compact") | No | default returns code/value objects; compact returns plain numeric values and cannot be combined with rounding or locale. |
| `value` | number | No | One amount to convert, greater than 0 and at most 10^18. Required unless values is supplied; mutually exclusive with values. |
| `locale` | string | No | ICU locale used to add formatted currency text, such as de_AT or en-US; unavailable with compact shape. Unknown locales return 422. |
| `values` | array | No | One to 100 amounts to convert in order, each greater than 0 and at most 10^18. Required unless value is supplied; mutually exclusive with value. |
| `datetime` | string | No | ISO 8601 moment within the connected plan's intraday history; mutually exclusive with date. This separately requires an update tier with intraday data: Small resolves hourly, Pro at quarter-hour intervals, and Medium or higher at minute intervals. Daily-update plans return 403, and moments outside retained intraday history return 422. |
| `precision` | integer | No | Number of decimal places in returned values, from 0 through 10. |
| `currencies` | array | No | Currency codes to convert into; omit to return all supported matches. |
| `round_mode` | string ("nearest" | "up" | "down") | No | Round to the nearest candidate, always up, or always down. |
| `round_step` | number | No | Round converted prices to a positive step no greater than 10^18. Mutually exclusive with price_ending and unavailable with compact shape. |
| `price_ending` | number | No | Round converted prices to this ending from 0 inclusive to 1 exclusive, such as 0.99. Mutually exclusive with round_step and unavailable with compact shape. |
| `base_currency` | string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LVL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMK" | "ZMW" | "ZWG" | "ZWL" | "BTC" | "ETH" | "BNB" | "XRP" | "SOL" | "DOT" | "AVAX" | "MATIC" | "LTC" | "ADA" | "USDT" | "USDC" | "DAI" | "ARB" | "OP" | "TRX") | No | Currency code of the amount being converted; defaults to USD. |
| `currency_type` | string ("fiat" | "metal" | "crypto") | No | Restrict destination currencies to fiat, metal, or crypto rates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Status

**Slug:** `CURRENCYAPI_GET_ACCOUNT_STATUS`

Return the connected account identifier, monthly quota, and plan details when present, without consuming quota.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Average Rates

**Slug:** `CURRENCYAPI_GET_AVERAGE_RATES`

Return average, minimum, and maximum exchange rates grouped by month, quarter, year, or the total requested date span.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `period` | string ("month" | "quarter" | "year" | "total") | No | Time grouping for aggregate rows. |
| `source` | string ("ecb" | "boe" | "cnb" | "nbp" | "norges" | "riksbank" | "nationalbanken" | "mnb" | "bnr" | "nbu" | "tcmb" | "nbm" | "nbrm" | "cbbh" | "cbr" | "nbg" | "cba" | "cbar" | "nbk" | "cbu" | "nbt" | "boi" | "pboc" | "bnm" | "bi" | "nrb" | "rba" | "fed" | "boc" | "bcb" | "bcra" | "bcrp" | "sfc" | "cbn" | "sarb") | No | Central-bank source code for official rates; mutually exclusive with currency_type. |
| `date_to` | string | Yes | Last UTC date in the aggregation window, in YYYY-MM-DD form. |
| `date_from` | string | Yes | First UTC date in the aggregation window, in YYYY-MM-DD form. |
| `currencies` | array | No | Currency codes to aggregate; omit to return all available matches. |
| `base_currency` | string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LVL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMK" | "ZMW" | "ZWG" | "ZWL" | "BTC" | "ETH" | "BNB" | "XRP" | "SOL" | "DOT" | "AVAX" | "MATIC" | "LTC" | "ADA" | "USDT" | "USDC" | "DAI" | "ARB" | "OP" | "TRX") | No | Three-letter base currency; omit for USD market data or the official source's native currency. |
| `currency_type` | string ("fiat" | "metal" | "crypto") | No | Restrict market data to fiat currencies, metals, or cryptocurrencies; mutually exclusive with source. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Exchange Rates

**Slug:** `CURRENCYAPI_GET_EXCHANGE_RATES`

Return latest rates when no date is supplied, or end-of-day rates for one historical date or up to 31 historical dates. date and dates are mutually exclusive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | One historical UTC date in YYYY-MM-DD form; mutually exclusive with dates. Omit both date fields for latest rates. |
| `dates` | array | No | Historical UTC dates in YYYY-MM-DD form; mutually exclusive with date. Each date consumes one quota request. |
| `shape` | string ("default" | "compact") | No | Response shape: default returns code/value objects; compact returns plain numeric rate values. |
| `inverse` | boolean | No | Also return inverse values for each selected rate. |
| `precision` | integer | No | Number of decimal places in returned rate values, from 0 through 10. |
| `currencies` | array | No | Currency codes to return; omit to return every currency matching currency_type. |
| `base_currency` | string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LVL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMK" | "ZMW" | "ZWG" | "ZWL" | "BTC" | "ETH" | "BNB" | "XRP" | "SOL" | "DOT" | "AVAX" | "MATIC" | "LTC" | "ADA" | "USDT" | "USDC" | "DAI" | "ARB" | "OP" | "TRX") | No | Three-letter currency code to use as the base, such as USD. |
| `currency_type` | string ("fiat" | "metal" | "crypto") | No | Restrict results to fiat currencies, metals, or cryptocurrencies. |
| `include_changes` | boolean | No | Include rate and percentage changes for latest rates; must be false when date or dates is supplied. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Official Rate Range

**Slug:** `CURRENCYAPI_GET_OFFICIAL_RATE_RANGE`

Return a central bank's official publications across a date range as structured JSON. Requires a Currencyapi Pro+ plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source` | string ("ecb" | "boe" | "cnb" | "nbp" | "norges" | "riksbank" | "nationalbanken" | "mnb" | "bnr" | "nbu" | "tcmb" | "nbm" | "nbrm" | "cbbh" | "cbr" | "nbg" | "cba" | "cbar" | "nbk" | "cbu" | "nbt" | "boi" | "pboc" | "bnm" | "bi" | "nrb" | "rba" | "fed" | "boc" | "bcb" | "bcra" | "bcrp" | "sfc" | "cbn" | "sarb") | Yes | Central-bank source code returned by List Official Sources. |
| `compare` | string | No | Set to market to include each publication day's market rate and the official rate's percentage difference from it. |
| `date_to` | string | Yes | Last date of the publication range, in YYYY-MM-DD form. It must be on or after date_from and no more than 366 days later. |
| `accuracy` | string ("day" | "week" | "month") | No | Publication interval: day returns every publication; week or month returns the last publication in each period. |
| `date_from` | string | Yes | First date of the publication range, in YYYY-MM-DD form. |
| `currencies` | array | No | Currency codes to include. Omit them to return every currency in each publication. |
| `base_currency` | string | No | Three-letter base currency. Omit it to use the source bank's native base currency. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Official Rates

**Slug:** `CURRENCYAPI_GET_OFFICIAL_RATES`

Return a central bank's latest or dated official publication, optionally compared with market rates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Requested publication date in YYYY-MM-DD form. The provider may return the newest publication up to 14 days earlier. |
| `source` | string ("ecb" | "boe" | "cnb" | "nbp" | "norges" | "riksbank" | "nationalbanken" | "mnb" | "bnr" | "nbu" | "tcmb" | "nbm" | "nbrm" | "cbbh" | "cbr" | "nbg" | "cba" | "cbar" | "nbk" | "cbu" | "nbt" | "boi" | "pboc" | "bnm" | "bi" | "nrb" | "rba" | "fed" | "boc" | "bcb" | "bcra" | "bcrp" | "sfc" | "cbn" | "sarb") | Yes | Central-bank source code returned by List Official Sources, such as ecb. |
| `currencies` | array | No | Currency codes to return from the official publication. |
| `base_currency` | string | No | Three-letter base currency. Omit it to use the source bank's native base currency. |
| `compare_to_market` | boolean | No | Include market values and percentage differences beside official rates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get OHLC Rates

**Slug:** `CURRENCYAPI_GET_OHLC_RATES`

Return hourly or daily open, high, low, and close candles for one to 10 currencies. This endpoint requires the Pro+ range feature. Hour candles require quarter-hourly updates or finer; day candles require hourly updates or finer. Returns JSON only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shape` | string ("default" | "compact") | No | Response candle shape. default returns named fields; compact returns [datetime, open, high, low, close]. |
| `interval` | string ("hour" | "day") | No | Length of each candle: hour or day. |
| `precision` | integer | No | Number of decimal places for candle values, from 0 through 10. |
| `currencies` | array | Yes | One to 10 currency codes for which to return candles. |
| `datetime_end` | string | Yes | ISO 8601 date or timezone-aware datetime at which the last candle begins; must be on or after datetime_start. |
| `base_currency` | string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LVL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMK" | "ZMW" | "ZWG" | "ZWL" | "BTC" | "ETH" | "BNB" | "XRP" | "SOL" | "DOT" | "AVAX" | "MATIC" | "LTC" | "ADA" | "USDT" | "USDC" | "DAI" | "ARB" | "OP" | "TRX") | No | Currency to which all candle values are relative. |
| `datetime_start` | string | Yes | ISO 8601 date or timezone-aware datetime at which the first candle begins. Hour intervals allow at most seven days of lookback; day intervals allow at most three calendar months. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Pair Rate

**Slug:** `CURRENCYAPI_GET_PAIR_RATE`

Return one currency pair's latest rate at the account plan's update interval, a past daily close, or an intraday historical rate, together with its inverse.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Past UTC date in YYYY-MM-DD form for the daily close; mutually exclusive with datetime. Omit both for the latest rate at the account plan's update interval. |
| `datetime` | string | No | Timezone-aware ISO 8601 moment within the account plan's intraday history; mutually exclusive with date. Daily-update plans return 403. |
| `precision` | integer | No | Number of decimal places in returned rate values, from 0 through 10. |
| `to_currency` | string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LVL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMK" | "ZMW" | "ZWG" | "ZWL" | "BTC" | "ETH" | "BNB" | "XRP" | "SOL" | "DOT" | "AVAX" | "MATIC" | "LTC" | "ADA" | "USDT" | "USDC" | "DAI" | "ARB" | "OP" | "TRX") | Yes | Three-letter code of the currency to convert to. |
| `from_currency` | string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LVL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMK" | "ZMW" | "ZWG" | "ZWL" | "BTC" | "ETH" | "BNB" | "XRP" | "SOL" | "DOT" | "AVAX" | "MATIC" | "LTC" | "ADA" | "USDT" | "USDC" | "DAI" | "ARB" | "OP" | "TRX") | Yes | Three-letter code of the currency to convert from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate Fluctuation

**Slug:** `CURRENCYAPI_GET_RATE_FLUCTUATION`

Return start, end, change, percentage change, high, low, and average rates between two UTC dates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_to` | string | Yes | Last UTC date in the comparison window, in YYYY-MM-DD form. |
| `date_from` | string | Yes | First UTC date in the comparison window, in YYYY-MM-DD form. |
| `currencies` | array | No | Currency codes to analyze; omit to include every currency matching currency_type. |
| `base_currency` | string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LVL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMK" | "ZMW" | "ZWG" | "ZWL" | "BTC" | "ETH" | "BNB" | "XRP" | "SOL" | "DOT" | "AVAX" | "MATIC" | "LTC" | "ADA" | "USDT" | "USDC" | "DAI" | "ARB" | "OP" | "TRX") | No | Three-letter currency code to use as the base. |
| `currency_type` | string ("fiat" | "metal" | "crypto") | No | Restrict results to fiat currencies, metals, or cryptocurrencies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate Matrix

**Slug:** `CURRENCYAPI_GET_RATE_MATRIX`

Return latest or daily historical cross-rates among 2 to 25 currencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Historical UTC date in YYYY-MM-DD form; omit for the latest matrix. |
| `precision` | integer | No | Number of decimal places in returned rates, from 0 through 10. |
| `currencies` | array | Yes | Two to 25 currency codes to include as both matrix rows and columns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rate Range

**Slug:** `CURRENCYAPI_GET_RATE_RANGE`

Return market exchange rates over a bounded datetime range. Requires a Pro+ plan with the range feature; the requested resolution must match the plan's update tier: Pro supports quarter-hour and coarser data, while minute accuracy requires Medium+ with one-minute updates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shape` | string ("default" | "compact") | No | Return code/value objects by default, or compact plain values and datetime/value pairs. |
| `orient` | string ("datetime" | "currency") | No | Return one point per datetime, or one oldest-first series per currency. |
| `accuracy` | string ("day" | "hour" | "quarter_hour" | "minute" | "week" | "month") | No | Interval represented by each returned rate point. |
| `precision` | integer | No | Number of decimal places in returned rates, from 0 through 10. |
| `currencies` | array | No | Currency codes to return; omit to return all supported currencies. |
| `datetime_end` | string | Yes | End of the range as an ISO 8601 datetime with a UTC offset; must be on or after datetime_start. |
| `base_currency` | string ("AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BYR" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LTL" | "LVL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XCG" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMK" | "ZMW" | "ZWG" | "ZWL" | "BTC" | "ETH" | "BNB" | "XRP" | "SOL" | "DOT" | "AVAX" | "MATIC" | "LTC" | "ADA" | "USDT" | "USDC" | "DAI" | "ARB" | "OP" | "TRX") | No | Currency to which every returned rate is relative. |
| `currency_type` | string ("fiat" | "metal" | "crypto") | No | Restrict results to fiat currencies, metals, or cryptocurrencies. |
| `datetime_start` | string | Yes | Start of the range as an ISO 8601 datetime with a UTC offset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Countries

**Slug:** `CURRENCYAPI_LIST_COUNTRIES`

List countries with currency, language, timezone, calling-code, and ISO metadata.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Currencies

**Slug:** `CURRENCYAPI_LIST_CURRENCIES`

List supported fiat currencies, metals, and cryptocurrencies with symbols, precision, and country metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currencies` | array | No | Currency codes to return; omit to list every supported currency. |
| `currency_type` | string ("fiat" | "metal" | "crypto") | No | Restrict results to fiat currencies, metals, or cryptocurrencies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Official Sources

**Slug:** `CURRENCYAPI_LIST_OFFICIAL_SOURCES`

List central banks and publication metadata, optionally filtered by currency or region. This call does not consume currencyapi quota.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string ("europe" | "asia" | "africa" | "north-america" | "south-america" | "oceania") | No | Geographic region used to filter central-bank sources. |
| `currency` | string | No | Currency code used to filter central banks by supported publication currencies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
