Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 3.05 KB

README.md

File metadata and controls

85 lines (60 loc) · 3.05 KB

> Currency exchange rates library for Laravel

Build status Total Downloads Scrutinizer Version

Swap allows you to retrieve currency exchange rates from various services such as Fixer or Yahoo and optionally cache the results.



QuickStart

  1. Install via Composer:
$ composer require florianv/laravel-swap php-http/message php-http/guzzle6-adapter
  1. Configure the Service Provider and alias:
// config/app.php
'providers' => [
    Swap\Laravel\SwapServiceProvider::class
],

'aliases' => [
    'Swap' => Swap\Laravel\Facades\Swap::class
]
  1. Publish the Package configuration
$ php artisan vendor:publish --provider="Swap\Laravel\SwapServiceProvider"
  1. Start using it!
// Get the latest EUR/USD rate
$rate = Swap::latest('EUR/USD');

// 1.129
$rate->getValue();

// 2016-08-26
$rate->getDate()->format('Y-m-d');

// Get the EUR/USD rate yesterday
$rate = Swap::historical('EUR/USD', Carbon\Carbon::yesterday());

Documentation

The complete documentation can be found here.

Services

Here is the list of the currently implemented services.

Service Base Currency Quote Currency Historical
Fixer * * Yes
European Central Bank EUR * Yes
Google * * No
Open Exchange Rates USD (free), * (paid) * Yes
Xignite * * Yes
Yahoo * * No
WebserviceX * * No
National Bank of Romania RON * No
Central Bank of the Republic of Turkey * TRY No
Central Bank of the Czech Republic * CZK No
currencylayer USD (free), * (paid) * Yes

Credits

License

The MIT License (MIT). Please see LICENSE for more information.