Login to follow
Currency Layer

Currency Layer (ODC)

Stable version 1.1.1 (Compatible with ODC)
Uploaded on 18 Apr by Community Labs
Currency Layer

Currency Layer (ODC)

Documentation
1.1.1

🔧 Prerequisites

To use this component, make sure you have the following set up:

  1. CurrencyLayer Account
    Sign up at currencylayer.com and grab your API Access Key from the dashboard.

  2. Install ArdoJSON for ODC
    The library relies on the ArdoJSON service to process JSON requests and responses. Please ensure it's installed in your environment.

  3. Pass the API Key in Requests
    After installing the library, all requests must include your access_key. This key is required to authenticate your API calls.

  4. Import Actions and Structures
    When using this service, remember to import the provided Actions and Structures into your module. These handle all API interactions and responses seamlessly.


📘 API Reference

All API calls are based on the CurrencyLayer REST API. You can find detailed documentation here:
👉 https://currencylayer.com/documentation

Below is a summary of the main available actions:


🔁 GetChange

Returns exchange rate data between two dates.

ParameterDescription
start_date(Required) Start of the date range
end_date(Required) End of the date range
source_currency(Optional) Source currency (default is USD)
currencies_list(Optional) Comma-separated list of currencies to filter

🔄 GetConvert

Performs real-time currency conversion.

ParameterDescription
from_currency(Required) Currency to convert from
to_currency(Required) Currency to convert to
amount(Required) Amount to convert

📅 GetHistorical

Fetches historical exchange rates for a specific date.

ParameterDescription
date(Required) Date in YYYY-MM-DD format
currencies_list(Optional) List of currencies to include

⏳ GetHistoricalConvert

Performs conversion using historical exchange rates.

ParameterDescription
from_currency(Required) Currency to convert from
to_currency(Required) Currency to convert to
amount(Required) Amount to convert
historical_date(Required) Date for historical conversion (YYYY-MM-DD)

📊 GetTimeFrame

Returns historical rates over a time period.

ParameterDescription
access_key(Required) Your API key
start_date(Required) Start date
end_date(Required) End date
source(Optional) Source currency
currencies(Optional) Filter list of currencies

⚡ GetLive

Returns the most recent exchange rates.

ParameterDescription
access_key(Required) Your API key
source(Optional) Source currency
currencies(Optional) List of target currencies

📜 GetList

Returns metadata about the API and supported currencies.

FieldDescription
successReturns true/false indicating success
termsLink to terms & conditions
privacyLink to privacy policy
currenciesList of supported currency codes