Custom Connector
Fixer.io Exchange Rate Connector
Global
The Fixer.io Exchange Rate Connector facilitates seamless integration with the Fixer.io API, providing access to real-time and historical exchange rate data for 170+ world currencies. It acts as a proxy supporting latest rates, currency conversions, historical rates, fluctuation data, and currency symbols.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, parameters, outputs, and workflow support using the Fixer.io Exchange Rate Connector.
- getLatestRates. Retrieves the latest exchange rates for all supported currencies relative to a base currency.
- getConversion. Retrieves the exchange rate or converts an amount between two currencies.
- getTimeSeriesRates. Retrieves historical exchange rates over a specified date range.
- getFluctuationData. Retrieves fluctuation data for currencies over a specified date range.
- getSupportedCurrencies. Retrieves a list of supported currency codes and their names.
- getHistoricalRates. Retrieves exchange rates for a specific date relative to a base currency.
Documentation
Detailed Integration Documentation
Latest Rates Retrieval
| Action | getLatestRates |
|---|---|
| Purpose | Retrieves the latest exchange rates for all supported currencies relative to a base currency. |
| Parameters | Required: apiKey – your Fixer.io API key (register at fixer.io). base – base currency code (ISO 4217, e.g. USD). Optional: symbols – comma-separated currency codes to limit the response (e.g. USD,GBP,EUR). |
| Configuration | Configure the base URL via CONNECTOR_ENV_FIXER_BASE_URL and set the API key. |
| Output | Successful: JSON with success, timestamp, base, date, and rates (currency codes → rate). Failure: error details (invalid_access_key). |
| Workflow example | Execute getLatestRates with apiKey and base=USD, then display exchange rates in a financial dashboard. |
Currency Conversion
| Action | getConversion |
|---|---|
| Purpose | Retrieves the exchange rate between two currencies or converts a specified amount. |
| Parameters | Required: apiKey, from (source ISO 4217, e.g. USD), to (target ISO 4217, e.g. INR). Optional: amount (float, e.g. 100), date (YYYY-MM-DD for historical conversion). |
| Configuration | Configure the base URL and set the API key. |
| Output | Successful: JSON with success, query (from, to, amount), info (timestamp, rate), date, result (converted amount). Failure: error details (invalid_currency_code). |
| Workflow example | Execute getConversion with apiKey, from=USD, to=INR, amount=100, then use the result for financial calculations or e-commerce. |
Time Series Rates Retrieval
| Action | getTimeSeriesRates |
|---|---|
| Purpose | Retrieves historical exchange rates over a specified date range for all or a specific set of currencies. |
| Parameters | Required: apiKey, start_date (YYYY-MM-DD), end_date (YYYY-MM-DD). Optional: base, symbols. |
| Configuration | Configure the base URL and set the API key. |
| Output | Successful: JSON with success, timeseries, start_date, end_date, base, and rates (daily objects). Failure: error details (invalid_date_range). |
| Workflow example | Execute getTimeSeriesRates with a date range, then analyze the series for trends or forecasting. |
Fluctuation Data Retrieval
| Action | getFluctuationData |
|---|---|
| Purpose | Retrieves fluctuation data for currencies over a specified date range. |
| Parameters | Required: apiKey, start_date (YYYY-MM-DD), end_date (YYYY-MM-DD). Optional: base, symbols. |
| Configuration | Configure the base URL and set the API key. |
| Output | Successful: JSON with success, fluctuation, start_date, end_date, base, and rates (start_rate, end_rate, change, change_pct). Failure: error details (invalid_date_range). |
| Workflow example | Execute getFluctuationData with a date range for risk assessment or investment planning. |
Historical Rates Retrieval
| Action | getHistoricalRates |
|---|---|
| Purpose | Retrieves exchange rates for a specific date relative to a base currency. |
| Parameters | Required: apiKey, date (YYYY-MM-DD), base. Optional: symbols. |
| Configuration | Configure the base URL and set the API key. |
| Output | Successful: JSON with success, timestamp, base, date, and rates. Failure: error details (no_data_available). |
| Workflow example | Execute getHistoricalRates with a date and base for historical analysis or research. |
Supported Currencies Retrieval
| Action | getSupportedCurrencies |
|---|---|
| Purpose | Retrieves a list of supported currency codes and their names. |
| Parameters | Required: apiKey. Optional: None. |
| Configuration | Configure the base URL and set the API key. |
| Output | Successful: JSON with success and symbols (currency code → name). Failure: error details (invalid_request). |
| Workflow example | Execute getSupportedCurrencies, then populate a currency selection dropdown. |
Example Workflow: Currency Conversion and Historical Analysis
| Retrieve supported currencies | Execute getSupportedCurrencies to fetch available codes and identify targets (USD, EUR, INR). |
|---|---|
| Query latest rates | Execute getLatestRates with base=USD to fetch current rates for a dashboard. |
| Perform conversion | Execute getConversion with from=USD, to=INR, amount=100. |
| Explore historical rates | Execute getHistoricalRates with a specific date for historical analysis. |
| Analyze time series | Execute getTimeSeriesRates over a date range for trends and forecasting. |
| Assess fluctuations | Execute getFluctuationData for risk assessment and volatility analysis. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.