Live Currency Rates Using Our NodeJS SDK

Adding your API Key with NodeJS

You're all set to start leveraging the CurrencyApi.net NodeJS SDK. Begin by creating an instance of the CurrencyApi class with your API key:

const currency = new CurrencyApi('YOUR_API_KEY');

Fetching Live Currency Rates with NodeJS

Let's dive into fetching live currency rates using the following method:

const result = await currency.rates().get();
// Or using promises
currency.rates().get()
    .then(console.log);

This will output the response containing all the currency rates of the default base currency. The default is USD.

The rates() method is a convenient way to access the /rates endpoint.

Here's a complete example showcasing the API response:

import CurrencyApi from './src/CurrencyApi.js';

const currency = new CurrencyApi('YOUR_API_KEY');

(async () => {
    try {
        const result = await currency.rates().get();
        console.log(result);
    } catch (error) {
        console.error(error);
    }
})();

# Outputs
{
    "valid": true,
    "updated": 1727622003,
    "base": "USD",
    "rates": {
        "AED": 3.673,
        "AFN": 68,
        "ALL": 88.25,
        "AMD": 387.32,
        "ANG": 1.801995,
        "AOA": 943.5,
        "ARS": 965.4662
        // ...
    }
}

Great! You've successfully retrieved live currency rates using our NodeJS SDK.

Available Methods for Rates Endpoint - NodeJS SDK

Method	Description
base()	Sets the base currency for conversions. Outputs all currency conversions for the specified currency. Default is USD.
output()	Specifies the response format: JSON or XML. Default is JSON.

Converting Currency Amounts

Easily convert amounts between currencies using our Currency API and NodeJS SDK. This method provides a streamlined response, optimizing performance and reducing data overhead.

The convert() method utilizes the /convert endpoint of our Currency API.

Let's convert 100 USD to EUR with the NodeJS SDK:

const result = await currency.convert().from('USD').to('EUR').amount(100).get();
console.log(result);

# Outputs
{
    "valid": true,
    "updated": 1727625603,
    "conversion": {
        "amount": 100,
        "from": "USD",
        "to": "EUR",
        "result": 85.37
    }
}

As shown, the response is concise and contains only the necessary conversion details.

Available Methods for Convert Endpoint - NodeJS SDK

Method	Description
from()	The currency you want to convert from. Must be a three-letter ISO 4217 currency code. Required.
to()	The currency you want to convert to. Must be a three-letter ISO 4217 currency code. Required.
amount()	The amount you wish to convert. Should be a numerical value and can include decimals. Required.
output()	Specifies the response format: JSON or XML. Default is JSON.

NodeJS - Fetching Historical Currency Rates

Need historical currency data? Our SDK provides endpoints to access past currency rates with ease.

The history() method leverages the /history endpoint of our Currency API.

Retrieve historical rates for USD on January 1st, 2024 using the NodeJS SDK:

const result = await currency.history().date('2024-01-01').base('USD').output('JSON').get();
console.log(result);

# Outputs
{
  valid: true,
  base: 'USD',
  date: '2024-01-01',
  rates: {
    AED: 3.6728,
    AFN: 70.83428,
    ALL: 93.79385,
    AMD: 405.595,
    ANG: 1.807342,
    AOA: 828.8,
    ARS: 810.8593,
    // ...
  }
}

The response provides a JSON object with historical currency rates for the specified date.

Available Methods for History Endpoint with NodeJS SDK

Method	Description
date()	The specific date for which you want historical currency rates. Format: YYYY-MM-DD. Required.
base()	Sets the base currency for conversions. Outputs all currency conversions for the specified currency. Default is USD.
output()	Specifies the response format: JSON or XML. Default is JSON.

Return multiple historical day rates with NodeJs

Accessing currency rates over a specific timeframe enables developers to build applications that monitor currency fluctuations over time, such as graphs, analytics dashboards, and more.

The timeframe() method utilizes the /timeframe endpoint of our Currency API.

Retrieve rates for USD between February 1st, 2023 and February 5th, 2023 using the NodeJS SDK:

const result = await currency.timeframe().startDate('2023-02-01').endDate('2023-02-05').get();
console.log(result);

# Outputs
{
    "valid": true,
    "base": "USD",
    "start_date": "2023-02-01",
    "end_date": "2023-02-05",
    "rates": {
        "2023-02-01": {
            "AED": 3.6728,
            "AFN": 70.83428,
            "ALL": 93.79385,
            "AMD": 405.595,
            "ANG": 1.807342,
            "AOA": 828.8,
            "ARS": 810.8593,
            // ...
        },
        // ...
        "2023-02-05": {
            "AED": 3.6732,
            "AFN": 88.64088,
            "ALL": 105.71149,
            "AMD": 391.9258,
            "ANG": 1.78267,
            "AOA": 504.30012,
            "ARS": 187.29207
            // ...
        }
    }
}

The API returns multiple days of currency rates in a single response, simplifying the process of tracking currency trends over time.

Available Methods for Timeframe Endpoint - NodeJS SDK

Method	Description
startDate()	The start date for the currency rate timeframe. Format: YYYY-MM-DD. Required.
endDate()	The end date for the currency rate timeframe. Format: YYYY-MM-DD. Required.
base()	Sets the base currency for conversions. Outputs all currency conversions for the specified currency. Default is USD.
output()	Specifies the response format: JSON or XML. Default is JSON.

Best Practices

To ensure a smooth and efficient integration with the NodeJS SDK, adhere to the following best practices:

• Cache API responses when appropriate to minimize redundant API calls and enhance performance.
• Implement robust error handling to gracefully manage unexpected issues and maintain application stability.
• Securely store your API key using environment variables to protect sensitive information.
• Regularly consult the official documentation for updates and advanced usage techniques.