jimmerioles/bitcoin-currency-converter-php

A simple and lightweight bitcoin to currency converter and vice versa based on current exchange rates from your chosen provider: Coinbase, Coindesk, Bitpay and etc.

Bitcoin Currency Converter

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

This library helps developers that need to easily convert bitcoin to fiat currency(ISO 4217) or to another cryptocurrency and vice versa from your exchange rates provider of choice., _(*2)

Available exchange rates providers are: * Coinbase * Coindesk * Bitpay, _(*3)

If you have any request for other exchange rates provider or other features that you would like for me to add see Contributing., _(*4)

Features

It is simple, lightweight, extensible, framework agnostic and fast., _(*5)

• You can convert Bitcoin to any currency (ISO 4217 fiat or another cryptocurrency)
• You can convert any currency (ISO 4217 fiat or another cryptocurrency) to Bitcoin
• It supports different exchange rates providers: Coinbase, Coindesk, Bitpay
• It has baked-in caching (PSR16 compliant, swappable with your own or your framework's)

PHP Versions Support

Install

Lets begin by installing the library by Composer:, _(*6)

``` bash $ composer require jimmerioles/bitcoin-currency-converter-php, <sub>(*7)</sub>

## Usage

#### You can then convert Bitcoin to any currency (ISO 4217 fiat or crypto) by:

``` php
use Jimmerioles\BitcoinCurrencyConverter\Converter;

$convert = new Converter;              // uses Coinbase as default provider
echo $convert->toCurrency('USD', 0.5); // 2000.00
echo $convert->toCurrency('LTC', 0.5); // 10.12345678

or you can use the helper function for convenience:, <sub>(*8)</sub>

``` php // uses Coinbase as default provider echo to_currency('USD', 0.5); // 2000.00 echo to_currency('LTC', 0.5); // 10.12345678, <sub>(*9)</sub>

#### You can also convert any currency (ISO 4217 fiat or crypto) to Bitcoin:

``` php
use Jimmerioles\BitcoinCurrencyConverter\Converter;

$convert = new Converter;         // uses Coinbase as default provider
echo $convert->toBtc(100, 'USD'); // 0.12345678
echo $convert->toBtc(20, 'LTC');  // 1.12345678

and it also has its helper function for convenience:, <sub>(*10)</sub>

``` php // uses Coinbase as default provider echo to_btc(100, 'USD'); // 0.12345678 echo to_btc(20, 'LTC'); // 2.12345678, <sub>(*11)</sub>

#### You can use different exchange rates from providers:

``` php
use Jimmerioles\BitcoinCurrencyConverter\Converter;
use Jimmerioles\BitcoinCurrencyConverter\Provider\CoinbaseProvider;
use Jimmerioles\BitcoinCurrencyConverter\Provider\CoindeskProvider;
use Jimmerioles\BitcoinCurrencyConverter\Provider\BitpayProvider;

$convert = new Converter(new CoinbaseProvider);
$convert = new Converter(new CoindeskProvider);
$convert = new Converter(new BitpayProvider);

or if you prefer to use the helper functions:, <sub>(*12)</sub>

``` php echo to_currency('USD', 0.5, new CoindeskProvider); // 2000.00 echo to_currency('LTC', 0.5, new BitpayProvider); // 10.12345678 echo to_btc(100, 'USD', new CoindeskProvider); // 0.12345678 echo to_btc(20, 'LTC', new BitpayProvider); // 2.12345678, <sub>(*13)</sub>

#### You can specify cache expire time (ttl) on provider by:

``` php
new CoinbaseProvider($httpClient, $psr16CacheImplementation, 5); // cache expires in 5mins, defaults to 60mins

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*14)</sub>

Testing

``` bash $ phpunit, <sub>(*15)</sub>

#### Show full specs and features:

``` bash
$ phpunit --testdox

Contributing

Open for suggestions and requests. Please request through issue or pull requests., <sub>(*16)</sub>

Security

If you discover any security related issues, please email jimwisleymerioles@gmail.com instead of using the issue tracker., <sub>(*17)</sub>

Credits

• Jim Merioles
• Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*18)</sub>

Want to show some :heart:?

Let's find Satoshi Nakamoto!	or let's have a :coffee:
	![Donate Ethereum][ico-ethereum]