Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Financial services
ExchangeRate Connector
Overview
The ExchangeRate Connector facilitates seamless integration with the ExchangeRate providing access to real-time and historical exchange rate data for 160+ world currencies. This connector acts as a proxy to streamline data retrieval, supporting actions for latest rates, pair conversions, historical data, supported currency codes, and localization data.
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the ExchangeRate Connector.
Supported Integration Action Points
- getLatestRates: Retrieves the latest exchange rates for all supported currencies relative to a base currency.
- getPairConversion:Retrieves the exchange rate between two specific currencies.
- getPairConversionWithAmount: Converts a specified amount between two currencies.
- getHistoricalRates: Retrieves exchange rates for a specific date relative to a base currency (Pro, Business, or Volume plans only).
- getHistoricalConversion: Converts an amount using historical exchange rates (Pro, Business, or Volume plans only).
- getSupportedCodes: Retrieves a list of supported currency codes and their names.
- getLocalizationData: Retrieves localization data for currencies, including names, symbols, regions, and flag URLs (Pro, Business, or Volume plans only).
Detailed Integration Documentation
Latest Rates Retrieval
Action
getLatestRates
Purpose
Retrieves a comprehensive list of the latest exchange rates for all supported currencies relative to a specified base currency. This serves as the primary entry point for accessing current exchange rate data.
Parameters
- Required:
- apiKey: Your API key (string, e.g., YOUR-API-KEY).
Register at www.exchangerate-api.com to obtain. - base_code: The base currency code (ISO 4217, string, e.g., USD).
- apiKey: Your API key (string, e.g., YOUR-API-KEY).
- Optional:None.
- Configuration:
- Ensure the connector is configured with the base URL via CONNECTOR_ENV_EXCHANGERATE_BASE_URL environment variable
Output
- Successful: Returns a JSON object with:
result: Success status (string, e.g., success).
time_last_update_unix: Unix timestamp of last update (integer, e.g., 1585267200).
time_last_update_utc: UTC timestamp of last update (string, e.g., “Fri, 27 Mar 2020 00:00:00 +0000”).
time_next_update_unix: Unix timestamp of next update (integer, e.g., 1585353700).
time_next_update_utc: UTC timestamp of next update (string, e.g., “Sat, 28 Mar 2020 00:00:00 +0000”).
base_code: Base currency code (string, e.g., USD).
conversion_rates: Object with currency codes and rates (e.g., USD: 1, AUD: 1.4817, EUR: 0.9013). - Failure: Returns error details (e.g., invalid currency code, error-type: unknown-code).
Workflow Example
1. Configure the connector with the appropriate base URL.
2. Execute the getLatestRates action with apiKey and base_code=USD.
3. Process the response to identify exchange rates for further actions
Pair Conversion Retrieval
Action
getPairConversion
Purpose
Retrieves the exchange rate between two specific currencies. This helps users obtain targeted currency pair data for financial applications.
Parameters
- Required:
- apiKey: Your API key (string, e.g., YOUR-API-KEY).
- base_code: Base currency code (ISO 4217, string, e.g., EUR).
- target_code: Target currency code (ISO 4217, string, e.g., GBP).
- Optional: None.
- Configuration:Ensure the connector is configured with the correct base URL.
Output
- Successful:Returns a JSON object with:
- result: Success status (string, e.g., success).
- documentation: Documentation URL (string).
- terms_of_use: Terms URL (string).
- time_last_update_unix: Unix timestamp (integer, e.g., 1585267200).
- time_last_update_utc: UTC timestamp (string, e.g., “Fri, 27 Mar 2020 00:00:00 +0000”).
- time_next_update_unix: Unix timestamp (integer, e.g., 1585270800).
- time_next_update_utc: UTC timestamp (string, e.g., “Sat, 28 Mar 2020 01:00:00 +0000”).
- base_code: Base currency code (string, e.g., EUR).
- target_code: Target currency code (string, e.g., GBP).
- conversion_rate: Exchange rate (float, e.g., 0.8412).
- Failure: Returns error details (e.g., error-type: unsupported-code).
Workflow Example
1. Execute the getPairConversion action with apiKey, base_code=EUR, and target_code=GBP.
2. Review the response to obtain the conversion rate.
3. Use the rate for financial calculations or display.
Pair Conversion with Amount
Action
getPairConversionWithAmount
Purpose
Converts a specified amount between two currencies using the current exchange rate. This allows tailored currency conversion for specific needs.
Parameters
- Required:
- apiKey: Your API key (string, e.g., YOUR-API-KEY).
- base_code: Base currency code (ISO 4217, string, e.g., EUR).
- target_code: Target currency code (ISO 4217, string, e.g., GBP).
- amount: Amount to convert (float, e.g., 100).
- Optional: None
- Configuration:Ensure the connector is configured with the correct base URL.
Output
- Successful:Returns a JSON object with:
- result: Success status (string, e.g., success).
- documentation: Documentation URL (string).
- terms_of_use: Terms URL (string).
- time_last_update_unix: Unix timestamp (integer, e.g., 1585267200).
- time_last_update_utc: UTC timestamp (string, e.g., “Fri, 27 Mar 2020 00:00:00 +0000”).
- time_next_update_unix: Unix timestamp (integer, e.g., 1585270800).
- time_next_update_utc: UTC timestamp (string, e.g., “Sat, 28 Mar 2020 01:00:00 +0000”).
- base_code: Base currency code (string, e.g., EUR).
- target_code: Target currency code (string, e.g., GBP).
- conversion_rate: Exchange rate (float, e.g., 0.8412).
- conversion_result: Converted amount (float, e.g., 84.12).
- Failure: Returns error details (e.g., error-type: invalid-request).
Workflow Example
1. Execute the getPairConversionWithAmount action with apiKey, base_code=EUR, target_code=GBP, and amount=100.
2. Save the converted amount for financial reporting or e-commerce applications.
3. Use the result for data analysis or user display.
Historical Rates Retrieval
Action
getHistoricalRates
Purpose
Retrieves exchange rates for a specific date relative to a base currency. This enables historical data analysis for research or reporting. Requires Pro, Business, or Volume plans.
Parameters
- Required:
- apiKey: Your API key (string, e.g., YOUR-API-KEY).
- base_code: Base currency code (ISO 4217, string, e.g., USD).
- year: Year of the historical date (integer, e.g., 2015).
- month: Month of the historical date (integer, 1-12, e.g., 2).
- day: Day of the historical date (integer, 1-31, e.g., 22).
- Optional: None
- Configuration:Ensure the connector is configured with the correct base URL. Requires a valid Pro, Business, or Volume plan subscription..
Output
- Successful:Returns a JSON object with:
- result: Success status (string, e.g., success).
- documentation: Documentation URL (string).
- terms_of_use: Terms URL (string).
- year: Year (integer, e.g., 2015).
- month: Month (integer, e.g., 2).
- day: Day (integer, e.g., 22).
- base_code: Base currency code (string, e.g., USD).
- conversion_rates: Object with currency codes and rates (e.g., AUD: 1.4196, EUR: 0.8929).
- Failure:Returns error details (e.g., error-type: no-data-available or 404).
Workflow Example
1. Verify Pro, Business, or Volume plan subscription.
2. Execute the getHistoricalRates action with apiKey, base_code=USD, year=2015, month=2, and day=22.
3. Review historical rates for trend analysis or academic research.
Historical Conversion with Amount
Action
getHistoricalConversion
Purpose
Converts an amount using historical exchange rates for a specific date. This provides detailed historical conversion data. Requires Pro, Business, or Volume plans.
Parameters
- Required:
- apiKey: Your API key (string, e.g., YOUR-API-KEY).
- base_code: Base currency code (ISO 4217, string, e.g., USD).
- year: Year of the historical date (integer, e.g., 2015).
- month: Month of the historical date (integer, 1-12, e.g., 2).
- day: Day of the historical date (integer, 1-31, e.g., 22).
- amount: Amount to convert (float, e.g., 4).
- Optional: None
- Configuration :Ensure the connector is configured with the correct base URL. Requires a valid Pro, Business, or Volume plan subscription.
Output
- Successful:Returns a JSON object with:
- result: Success status (string, e.g., success).
- documentation: Documentation URL (string).
- terms_of_use: Terms URL (string).
- year: Year (integer, e.g., 2015).
- month: Month (integer, e.g., 2).
- day: Day (integer, e.g., 22).
- base_code: Base currency code (string, e.g., USD).
- requested_amount: Amount to convert (float, e.g., 4).
- conversion_amounts: Object with converted amounts (e.g., AUD: 5.664, EUR: 3.5716).
- Failure:Returns error details (e.g., error-type: invalid-request or 404).
Workflow Example
1. Verify Pro, Business, or Volume plan subscription.
2. Execute the getHistoricalConversion action with apiKey, base_code=USD, year=2015, month=2, day=22, and amount=4.
3. Use the converted amounts for historical financial analysis.
Supported Codes Retrieval
Action
getSupportedCodes
Purpose
Retrieves a list of supported currency codes and their names. This helps users validate currency codes or build currency selection interfaces.
Parameters
- Required:
- apiKey: Your API key (string, e.g., YOUR-API-KEY).
- Optional: None
- Configuration :Ensure the connector is configured with the correct base URL.
Output
- Successful:Returns a JSON object with:
- result: Success status (string, e.g., success).
- documentation: Documentation URL (string).
- terms_of_use: Terms URL (string).
- supported_codes: Array of arrays with currency code and name (e.g., [“USD”, “US Dollar”], [“EUR”, “Euro”]).
- Failure:Returns error details (e.g., error-type: invalid-request).
Workflow Example
1. Execute the getSupportedCodes action with apiKey.
2. Review the response to select currency codes (e.g., USD, EUR).
3. Use the codes to populate a currency selection dropdown.
Localization Data Retrieval
Action
getLocalizationData
Purpose
Retrieves localization data for supported currencies, including currency names, display symbols, associated regions, and flag image URLs. This enables enhanced UI integration. Requires Pro, Business, or Volume plans.
Parameters
- Required:
- apiKey: Your API key (string, e.g., YOUR-API-KEY).
- Optional: None
- Configuration :Ensure the connector is configured with the correct base URL. Requires a valid Pro, Business, or Volume plan subscription.
Output
- Successful:Returns a JSON object with:
- result: Success status (string, e.g., success).
- documentation: Documentation URL (string).
- terms_of_use: Terms URL (string).
- currencies: Object with currency data (e.g., USD: {name: “US Dollar”, symbol: “$”, region: “United States”, flag_url: “https://www.exchangerate-api.com/flags/usd.png”}).
- Failure:Returns error details (e.g., error-type: invalid-request or 403).
Workflow Example
1. Verify Pro, Business, or Volume plan subscription.
2. Execute the getLocalizationData action with apiKey.
3. Use the localization data to enhance UI with currency symbols and flags.
Workflow Creation with the Connector
Example Workflow: Currency Conversion and Historical Analysis
Retrieve Supported Codes
- Use the getSupportedCodes action to fetch a list of available currency codes.
- Identify target currencies (e.g., USD, EUR).
Query Latest Rates
- Execute the getLatestRates action with apiKey and base_code=USD to fetch current exchange rates.
- Process the response to display rates in a financial dashboard.
Perform Pair Conversion
- Use the getPairConversionWithAmount action with apiKey, base_code=USD, target_code=EUR, and amount=100 to convert an amount.
- Save the converted amount for e-commerce or reporting.
Explore Historical Data (Pro, Business, or Volume plans)
- Execute the getHistoricalRates action with apiKey, base_code=USD, year=2015, month=2, and day=22 to fetch historical rates.
- Use the getHistoricalConversion action with apiKey, base_code=USD, year=2015, month=2, day=22, and amount=4 to convert an amount.
- Analyze historical data for research or trend analysis.
Enhance UI with Localization (Pro, Business, or Volume plans)
- Execute the getLocalizationData action with apiKey to fetch currency symbols and flags.
- Integrate the data into a currency selection interface for improved user experience.
Pricing
iSolution logo - white - transparent 250 px