Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 2.14 KB

README.md

File metadata and controls

82 lines (60 loc) · 2.14 KB

DEPRECATED

Stay up to date by following @apilayernet on Twitter.

JavaScript client for the currencylayer API

Currencylayer is a free, powerful REST-based JSON API offering accurate and reliable spot exchange rates (quotes) for 168 world currencies & precious metals.

Website: currencylayer.com

Installation

Download the file currencylayer.min.js and include it in your website:

<script src="currencylayer.min.js"></script>

Set your API Access Key:

CL.access_key('YOUR_ACCESS_KEY');

Usage examples

"live" endpoint - request real-time quotes

/* Example: USDEUR */
CL.source('USD').currencies('EUR').live(function(result) {
    console.log('USDEUR: ' + result.quotes.USDEUR);
});

"historical" endpoint - request historical quotes

/* Example: USDEUR on October 10th, 2001 */
CL.source('USD').currencies('EUR').date('2001-10-10').historical(function(result) {
    console.log('USDEUR on 2001-10-10: ' + result.quotes.USDEUR);
});

"convert" endpoint - convert currencies

/* Example: Convert USD 10 to EUR */
CL.from('USD').to('EUR').amount('10').convert(function(result) {
    console.log('USD 10 in EUR: ' + result.result);
});

"timeframe" endpoint - request quotes for a specific timeframe

/* Example: USDEUR quotes between October and November 2010  */
CL.source('USD').currencies('EUR').start_date('2010-10-01').end_date('2010-11-01').timeframe(function(result) {
    console.log('Quotes: ' + result.quotes);
});

"change" endpoint - request change parameters for a specific timeframe

/* Example: USDEUR change between the years 2010 and 2015  */
CL.source('USD').currencies('EUR').start_date('2010-01-01').end_date('2015-01-01').change(function(result) {
    console.log('USDEUR change between 2010-2015: ' + result.quotes.USDEUR.change);
});

API Documentation

See: currencylayer.com/documentation

Get Free API Access

Start using the currencylayer API for free: currencylayer.com/product