# CurrencyScoop

CurrencyBeacon is a developer friendly, easy-to-use REST API with real-time and historical exchange rates for fiat currencies and cryptocurrencies.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 5
- **Triggers:** 0
- **Slug:** `CURRENCYSCOOP`
- **Version:** 20260316_00

## Tools

### Convert Currency with Historical Support

**Slug:** `CURRENCYSCOOP_CONVERT_CURRENCY2`

Tool to convert any amount from one currency to another using real-time or historical exchange rates. Use when you need to convert a specific amount between two currencies, optionally specifying a date for historical rates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | Yes | The 3-letter currency code to convert to (e.g., EUR, USD, JPY). |
| `date` | string | No | Optional date for historical conversion in YYYY-MM-DD format. If omitted, uses current real-time rates. |
| `from` | string | Yes | The 3-letter currency code to convert from (e.g., USD, EUR, GBP). |
| `amount` | string | Yes | The numeric amount to convert. Must be a positive number. |

#### 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 Currencies

**Slug:** `CURRENCYSCOOP_GET_CURRENCIES`

Tool to retrieve all supported currencies including their names and countries. Use when you need information about available currencies, either fiat or crypto.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("fiat" | "crypto") | Yes | The type of currencies to retrieve. Must be either 'fiat' for traditional currencies or 'crypto' for 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 Historical Exchange Rates

**Slug:** `CURRENCYSCOOP_GET_HISTORICAL_RATES`

Tool to retrieve historical exchange rate data for past dates going back to 1996. Use when you need to access exchange rates for a specific historical date with a base currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `base` | string | Yes | The base currency code for exchange rates (e.g., USD, EUR, GBP). Returned rates are expressed as units of target currency per 1 unit of base currency. |
| `date` | string | Yes | The historical date for rate retrieval in YYYY-MM-DD format. Dates available from 1996 onwards. Other formats are rejected. Future dates or dates before 1996 return empty/missing data rather than an error. |
| `symbols` | string | No | Comma-separated list of target currency codes to retrieve rates for. If omitted, returns all available currencies. Omitting produces large responses; specify only needed 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 |

### Get Latest Exchange Rates

**Slug:** `CURRENCYSCOOP_GET_LATEST_RATES`

Tool to retrieve real-time exchange rate data for all available currencies. Use when you need current exchange rates updated based on subscription plan frequency (e.g., every 60 seconds). Returns only current rates, not historical values; use CURRENCYSCOOP_GET_HISTORICAL_RATES for rates on a specific past date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `base` | string | No | Three-letter currency code for the base currency (e.g., USD, EUR, GBP). Defaults to USD if omitted. This is the currency that all other rates will be quoted against. |
| `symbols` | string | No | Comma-separated list of target currency codes to filter results (e.g., GBP,JPY,EUR). If omitted, returns rates for all supported 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 |

### Get Timeseries Exchange Rates

**Slug:** `CURRENCYSCOOP_GET_TIMESERIES_RATES`

Tool to retrieve historical exchange rates for a given time period between start and end dates. Use when you need exchange rates for multiple dates in a date range for trend analysis or historical comparisons.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `base` | string | Yes | The base currency code for exchange rates (e.g., USD, EUR, GBP). This is the currency that all other rates will be quoted against. |
| `symbols` | string | No | Comma-separated list of target currency codes to retrieve rates for. If omitted, returns rates for all available currencies. Omitting this significantly inflates payload size and processing time; specify only needed codes when possible. |
| `end_date` | string | Yes | End date for the time series in YYYY-MM-DD format. This is the end of the time period for which you want historical rates. |
| `start_date` | string | Yes | Start date for the time series in YYYY-MM-DD format. This is the beginning of the time period for which you want historical rates. Must fall within CurrencyScoop's supported historical range; out-of-range dates return empty or partial data. |

#### 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 |
