npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

currencylayer-client

v1.1.0

Published

A nodejs client to consume the CurrencyLayer API for exchange rates & currency conversion

Downloads

130

Readme

Build Status Coverage Status

baldercm/currencylayer-client

A nodejs client to consume the CurrencyLayer API for exchange rates & currency conversion.

See https://currencylayer.com/documentation for further details.

Installation

Install the module using npm:

npm i --save currencylayer-client

Basic Usage

You can instantiate the client passing your API key:

const CurrencyLayerClient = require('currencylayer-client')

// for FREE plans, will use HTTP endpoints
let client = new CurrencyLayerClient({apiKey: 'YOURAPIKEY'})

// for NON FREE plans, will use HTTPS endpoints
let client = new CurrencyLayerClient({apiKey: 'YOURAPIKEY', free: false})

All client methods return a (bluebird) Promise:

  • a promise resolved with the full response body for success=true responses
// succesfull response resolves with body
{
  "success": true,
  "terms": "https://currencylayer.com/terms",
  "privacy": "https://currencylayer.com/privacy",
  "timestamp": 1432400348,
  "source": "USD",
  "quotes": {
    "USDAUD": 1.278342,
    "USDEUR": 0.908019,
    "USDGBP": 0.645558,
    "USDPLN": 3.731504
  }
}
  • a promise rejected with an error holding the code and info for success=false responses
// fail response rejects with error
{
  "success": false,
  "error": {
    "code": 104,
    "info": "Your monthly usage limit has been reached. Please upgrade your subscription plan."    
  }
}

client.live()
.catch(err => {
  console.log(err.code)    // 104
  console.log(err.message) // Your monthly usage limit has been reached...
})

live({currencies, source})

Will get the live rate for the given currencies and source.

All parameters are optional.

Remember source param is only available for non-free plans.

client.live()

// currencies as string
client.live({currencies: 'GBP,USD', source: 'EUR'})

// currencies as array
client.live({currencies: ['GBP', 'USD'], source: 'EUR'})

historical({date, currencies, source})

Will get the historical rate for the given date, currencies and source.

All parameters are optional.

Remember source param is only available for non-free plans.

// date default to current day
client.historical()

// currencies as string, date as string
client.historical({date: '2000-01-01', currencies: 'GBP,USD', source: 'EUR'})

// currencies as array, date as date
client.historical({date: new Date(2000, 0, 1), currencies: ['GBP', 'USD'], source: 'EUR'})

convert({from, to, amount, date})

Will convert the given amount.

from, to and amount are required, date is optional.

Remember convert() is only available for non-free plans.

// date default to current day
client.convert({from: 'EUR', to: 'USD', amount: 10})

// date as string
client.convert({date: '2000-01-01', from: 'EUR', to: 'USD', amount: 10})

// date as date
client.convert({date: new Date(2000, 0, 1), from: 'EUR', to: 'USD', amount: 10})

Contributing

git clone https://github.com/baldercm/currencylayer-client
npm install
npm test
npm run lint

License

MIT