thefabulous/java-exchange-rates

JAVA Library for currency conversion

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.thefabulous:java-exchange-rates:1.0'
	}
	dependencies {
		implementation("com.github.thefabulous:java-exchange-rates:1.0")
	}
	<dependency>
	    <groupId>com.github.thefabulous</groupId>
	    <artifactId>java-exchange-rates</artifactId>
	    <version>1.0</version>
	</dependency>

                            
    libraryDependencies += "com.github.thefabulous" % "java-exchange-rates" % "1.0"
        
        

                            
    :dependencies [[com.github.thefabulous/java-exchange-rates "1.0"]]

Readme

Build Status

Jitpack

Java exchange rates API

A Java library which provides API for currency conversion. It uses different web based servivces to obtain live conversion rates, store them and allow offline currency conversions.

To allow offline conversion, this library stores conversion rates obtained from the web-service and uses the stored exchange rates for offline conversion. Each time the Library is run it checks if the conversion rates stored are outdated. If it finds outdated exchange rates it updates the stored exchange rates (using the web-service defined) and then completes the conversion task. To instuct the code when to consider exchange rates as outdated set the refreshRate parameter. An example code below explains this scenario.

supported web-services:

  1. currencyLayer API (A access token is required to use this service, a free token can be obtained from here.)
  2. Yahoo finance currency exchange rate service

Example Use:

using the yahoo finance endpoint

// create the appropriate servive object
private CurrencyConverter converter = new CurrencyConverterBuilder()
				.strategy(Strategy.YAHOO_FINANCE_FILESTORE)
				.buildConverter();

// set the refresh rate  to set timer to update new exchange rates
converter.setRefreshRateSeconds(86400);

// convert between currencies
// general format of conversion is convertCurrency(amount, fromCurrency, toCurrency)
// example conversion of 100 USD to EUR is:
converter.convertCurrency(new BigDecimal("100"), Currency.USD, Currency.EUR)
// Thats how easy it is......

using the currency layer endpoint (needs access key)

// create the appropriate servive object
private CurrencyConverter converter = new CurrencyConverterBuilder()
				.strategy(Strategy.CURRENCY_LAYER_FILESTORE)
				.accessKey(YOUR_ACCESS_KEY)
				.buildConverter();

// set the refresh rate  to set timer to update new exchange rates
converter.setRefreshRateSeconds(86400);

// convert between currencies
// general format of conversion is convertCurrency(amount, fromCurrency, toCurrency)
// example conversion of 100 USD to EUR is:
converter.convertCurrency(new BigDecimal("100"), Currency.USD, Currency.EUR)
// Thats how easy it is......

Yahoo finance endpoint has different timestamps for each currency exchange rate. This library checks for the updated exchange rate for the desiered currencies efore the conversion task. This behaviour is controlled by the refreshRate parameter.

To set the file path where files should be stored on disk, simply use:

converter.setResourceFilepath(DESIERED_FILEPATH);

The default filepath is picked up from Java System.getProperty("java.io.tmpdir");

This library can be grabbed using Jitpack.io:

MAVEN

<repository>
	    <id>jitpack.io</id>
	    <url>https://jitpack.io</url>
</repository>

and then add dependancy

<dependency>
	    <groupId>com.github.Ritaja</groupId>
	    <artifactId>java-exchange-rates</artifactId>
	    <version>1.0</version>
</dependency>

GRADLE

 repositories {
        // ...
        maven { url "https://jitpack.io" }
    }

and then add dependancy

dependencies {
	        compile 'com.github.Ritaja:java-exchange-rates:1.0'
	}

The list of supported currencies at the moment limited to service provided by currecyLayer API which includes the following 168 currencies:

<table> <thead> <tr> <th>Code</th> <th>Name</th> </tr> </thead> <tbody> <tr> <td>AED</td> <td>United Arab Emirates Dirham</td> </tr> <tr> <td>AFN</td> <td>Afghan Afghani</td> </tr> <tr> <td>ALL</td> <td>Albanian Lek</td> </tr> <tr> <td>AMD</td> <td>Armenian Dram</td> </tr> <tr> <td>ANG</td> <td>Netherlands Antillean Guilder</td> </tr> <tr> <td>AOA</td> <td>Angolan Kwanza</td> </tr> <tr> <td>ARS</td> <td>Argentine Peso</td> </tr> <tr> <td>AUD</td> <td>Australian Dollar</td> </tr> <tr> <td>AWG</td> <td>Aruban Florin</td> </tr> <tr> <td>AZN</td> <td>Azerbaijani Manat</td> </tr> <tr> <td>BAM</td> <td>Bosnia-Herzegovina Convertible Mark</td> </tr> <tr> <td>BBD</td> <td>Barbadian Dollar</td> </tr> <tr> <td>BDT</td> <td>Bangladeshi Taka</td> </tr> <tr> <td>BGN</td> <td>Bulgarian Lev</td> </tr> <tr> <td>BHD</td> <td>Bahraini Dinar</td> </tr> <tr> <td>BIF</td> <td>Burundian Franc</td> </tr> <tr> <td>BMD</td> <td>Bermudan Dollar</td> </tr> <tr> <td>BND</td> <td>Brunei Dollar</td> </tr> <tr> <td>BOB</td> <td>Bolivian Boliviano</td> </tr> <tr> <td>BRL</td> <td>Brazilian Real</td> </tr> <tr> <td>BSD</td> <td>Bahamian Dollar</td> </tr> <tr> <td>BTC</td> <td>Bitcoin</td> </tr> <tr> <td>BTN</td> <td>Bhutanese Ngultrum</td> </tr> <tr> <td>BWP</td> <td>Botswanan Pula</td> </tr> <tr> <td>BYR</td> <td>Belarusian Ruble</td> </tr> <tr> <td>BZD</td> <td>Belize Dollar</td> </tr> <tr> <td>CAD</td> <td>Canadian Dollar</td> </tr> <tr> <td>CDF</td> <td>Congolese Franc</td> </tr> <tr> <td>CHF</td> <td>Swiss Franc</td> </tr> <tr> <td>CLF</td> <td>Chilean Unit of Account (UF)</td> </tr> <tr> <td>CLP</td> <td>Chilean Peso</td> </tr> <tr> <td>CNY</td> <td>Chinese Yuan</td> </tr> <tr> <td>COP</td> <td>Colombian Peso</td> </tr> <tr> <td>CRC</td> <td>Costa Rican Colón</td> </tr> <tr> <td>CUC</td> <td>Cuban Convertible Peso</td> </tr> <tr> <td>CUP</td> <td>Cuban Peso</td> </tr> <tr> <td>CVE</td> <td>Cape Verdean Escudo</td> </tr> <tr> <td>CZK</td> <td>Czech Republic Koruna</td> </tr> <tr> <td>DJF</td> <td>Djiboutian Franc</td> </tr> <tr> <td>DKK</td> <td>Danish Krone</td> </tr> <tr> <td>DOP</td> <td>Dominican Peso</td> </tr> <tr> <td>DZD</td> <td>Algerian Dinar</td> </tr> <tr> <td>EEK</td> <td>Estonian Kroon</td> </tr> <tr> <td>EGP</td> <td>Egyptian Pound</td> </tr> <tr> <td>ERN</td> <td>Eritrean Nakfa</td> </tr> <tr> <td>ETB</td> <td>Ethiopian Birr</td> </tr> <tr> <td>EUR</td> <td>Euro</td> </tr> <tr> <td>FJD</td> <td>Fijian Dollar</td> </tr> <tr> <td>FKP</td> <td>Falkland Islands Pound</td> </tr> <tr> <td>GBP</td> <td>British Pound Sterling</td> </tr> <tr> <td>GEL</td> <td>Georgian Lari</td> </tr> <tr> <td>GGP</td> <td>Guernsey Pound</td> </tr> <tr> <td>GHS</td> <td>Ghanaian Cedi</td> </tr> <tr> <td>GIP</td> <td>Gibraltar Pound</td> </tr> <tr> <td>GMD</td> <td>Gambian Dalasi</td> </tr> <tr> <td>GNF</td> <td>Guinean Franc</td> </tr> <tr> <td>GTQ</td> <td>Guatemalan Quetzal</td> </tr> <tr> <td>GYD</td> <td>Guyanaese Dollar</td> </tr> <tr> <td>HKD</td> <td>Hong Kong Dollar</td> </tr> <tr> <td>HNL</td> <td>Honduran Lempira</td> </tr> <tr> <td>HRK</td> <td>Croatian Kuna</td> </tr> <tr> <td>HTG</td> <td>Haitian Gourde</td> </tr> <tr> <td>HUF</td> <td>Hungarian Forint</td> </tr> <tr> <td>IDR</td> <td>Indonesian Rupiah</td> </tr> <tr> <td>ILS</td> <td>Israeli New Sheqel</td> </tr> <tr> <td>IMP</td> <td>Manx pound</td> </tr> <tr> <td>INR</td> <td>Indian Rupee</td> </tr> <tr> <td>IQD</td> <td>Iraqi Dinar</td> </tr> <tr> <td>IRR</td> <td>Iranian Rial</td> </tr> <tr> <td>ISK</td> <td>Icelandic Króna</td> </tr> <tr> <td>JEP</td> <td>Jersey Pound</td> </tr> <tr> <td>JMD</td> <td>Jamaican Dollar</td> </tr> <tr> <td>JOD</td> <td>Jordanian Dinar</td> </tr> <tr> <td>JPY</td> <td>Japanese Yen</td> </tr> <tr> <td>KES</td> <td>Kenyan Shilling</td> </tr> <tr> <td>KGS</td> <td>Kyrgystani Som</td> </tr> <tr> <td>KHR</td> <td>Cambodian Riel</td> </tr> <tr> <td>KMF</td> <td>Comorian Franc</td> </tr> <tr> <td>KPW</td> <td>North Korean Won</td> </tr> <tr> <td>KRW</td> <td>South Korean Won</td> </tr> <tr> <td>KWD</td> <td>Kuwaiti Dinar</td> </tr> <tr> <td>KYD</td> <td>Cayman Islands Dollar</td> </tr> <tr> <td>KZT</td> <td>Kazakhstani Tenge</td> </tr> <tr> <td>LAK</td> <td>Laotian Kip</td> </tr> <tr> <td>LBP</td> <td>Lebanese Pound</td> </tr> <tr> <td>LKR</td> <td>Sri Lankan Rupee</td> </tr> <tr> <td>LRD</td> <td>Liberian Dollar</td> </tr> <tr> <td>LSL</td> <td>Lesotho Loti</td> </tr> <tr> <td>LTL</td> <td>Lithuanian Litas</td> </tr> <tr> <td>LVL</td> <td>Latvian Lats</td> </tr> <tr> <td>LYD</td> <td>Libyan Dinar</td> </tr> <tr> <td>MAD</td> <td>Moroccan Dirham</td> </tr> <tr> <td>MDL</td> <td>Moldovan Leu</td> </tr> <tr> <td>MGA</td> <td>Malagasy Ariary</td> </tr> <tr> <td>MKD</td> <td>Macedonian Denar</td> </tr> <tr> <td>MMK</td> <td>Myanma Kyat</td> </tr> <tr> <td>MNT</td> <td>Mongolian Tugrik</td> </tr> <tr> <td>MOP</td> <td>Macanese Pataca</td> </tr> <tr> <td>MRO</td> <td>Mauritanian Ouguiya</td> </tr> <tr> <td>MUR</td> <td>Mauritian Rupee</td> </tr> <tr> <td>MVR</td> <td>Maldivian Rufiyaa</td> </tr> <tr> <td>MWK</td> <td>Malawian Kwacha</td> </tr> <tr> <td>MXN</td> <td>Mexican Peso</td> </tr> <tr> <td>MYR</td> <td>Malaysian Ringgit</td> </tr> <tr> <td>MZN</td> <td>Mozambican Metical</td> </tr> <tr> <td>NAD</td> <td>Namibian Dollar</td> </tr> <tr> <td>NGN</td> <td>Nigerian Naira</td> </tr> <tr> <td>NIO</td> <td>Nicaraguan Córdoba</td> </tr> <tr> <td>NOK</td> <td>Norwegian Krone</td> </tr> <tr> <td>NPR</td> <td>Nepalese Rupee</td> </tr> <tr> <td>NZD</td> <td>New Zealand Dollar</td> </tr> <tr> <td>OMR</td> <td>Omani Rial</td> </tr> <tr> <td>PAB</td> <td>Panamanian Balboa</td> </tr> <tr> <td>PEN</td> <td>Peruvian Nuevo Sol</td> </tr> <tr> <td>PGK</td> <td>Papua New Guinean Kina</td> </tr> <tr> <td>PHP</td> <td>Philippine Peso</td> </tr> <tr> <td>PKR</td> <td>Pakistani Rupee</td> </tr> <tr> <td>PLN</td> <td>Polish Zloty</td> </tr> <tr> <td>PYG</td> <td>Paraguayan Guarani</td> </tr> <tr> <td>QAR</td> <td>Qatari Rial</td> </tr> <tr> <td>RON</td> <td>Romanian Leu</td> </tr> <tr> <td>RSD</td> <td>Serbian Dinar</td> </tr> <tr> <td>RUB</td> <td>Russian Ruble</td> </tr> <tr> <td>RWF</td> <td>Rwandan Franc</td> </tr> <tr> <td>SAR</td> <td>Saudi Riyal</td> </tr> <tr> <td>SBD</td> <td>Solomon Islands Dollar</td> </tr> <tr> <td>SCR</td> <td>Seychellois Rupee</td> </tr> <tr> <td>SDG</td> <td>Sudanese Pound</td> </tr> <tr> <td>SEK</td> <td>Swedish Krona</td> </tr> <tr> <td>SGD</td> <td>Singapore Dollar</td> </tr> <tr> <td>SHP</td> <td>Saint Helena Pound</td> </tr> <tr> <td>SLL</td> <td>Sierra Leonean Leone</td> </tr> <tr> <td>SOS</td> <td>Somali Shilling</td> </tr> <tr> <td>SRD</td> <td>Surinamese Dollar</td> </tr> <tr> <td>STD</td> <td>São Tomé and Príncipe Dobra</td> </tr> <tr> <td>SVC</td> <td>Salvadoran Colón</td> </tr> <tr> <td>SYP</td> <td>Syrian Pound</td> </tr> <tr> <td>SZL</td> <td>Swazi Lilangeni</td> </tr> <tr> <td>THB</td> <td>Thai Baht</td> </tr> <tr> <td>TJS</td> <td>Tajikistani Somoni</td> </tr> <tr> <td>TMT</td> <td>Turkmenistani Manat</td> </tr> <tr> <td>TND</td> <td>Tunisian Dinar</td> </tr> <tr> <td>TOP</td> <td>Tongan Paʻanga</td> </tr> <tr> <td>TRY</td> <td>Turkish Lira</td> </tr> <tr> <td>TTD</td> <td>Trinidad and Tobago Dollar</td> </tr> <tr> <td>TWD</td> <td>New Taiwan Dollar</td> </tr> <tr> <td>TZS</td> <td>Tanzanian Shilling</td> </tr> <tr> <td>UAH</td> <td>Ukrainian Hryvnia</td> </tr> <tr> <td>UGX</td> <td>Ugandan Shilling</td> </tr> <tr> <td>USD</td> <td>United States Dollar</td> </tr> <tr> <td>UYU</td> <td>Uruguayan Peso</td> </tr> <tr> <td>UZS</td> <td>Uzbekistan Som</td> </tr> <tr> <td>VEF</td> <td>Venezuelan Bolívar Fuerte</td> </tr> <tr> <td>VND</td> <td>Vietnamese Dong</td> </tr> <tr> <td>VUV</td> <td>Vanuatu Vatu</td> </tr> <tr> <td>WST</td> <td>Samoan Tala</td> </tr> <tr> <td>XAF</td> <td>CFA Franc BEAC</td> </tr> <tr> <td>XAG</td> <td>Silver (troy ounce)</td> </tr> <tr> <td>XAU</td> <td>Gold (troy ounce)</td> </tr> <tr> <td>XCD</td> <td>East Caribbean Dollar</td> </tr> <tr> <td>XDR</td> <td>Special Drawing Rights</td> </tr> <tr> <td>XOF</td> <td>CFA Franc BCEAO</td> </tr> <tr> <td>XPF</td> <td>CFP Franc</td> </tr> <tr> <td>YER</td> <td>Yemeni Rial</td> </tr> <tr> <td>ZAR</td> <td>South African Rand</td> </tr> <tr> <td>ZMK</td> <td>Zambian Kwacha (pre-2013)</td> </tr> <tr> <td>ZMW</td> <td>Zambian Kwacha</td> </tr> <tr> <td>ZWL</td> <td>Zimbabwean Dollar</td> </tr> </tbody> </table>