amodar / laravel-swap
Currency exchange rates library for Laravel and Lumen
Requires
- php: ^7.1.3
- amodar/illuminate-adapter: ^0.2.1
- cache/simple-cache-bridge: ^1.0
- florianv/swap: ^4.0
Requires (Dev)
- graham-campbell/testbench: ~5.2
- nyholm/psr7: ^1.0
- php-http/guzzle6-adapter: ^1.0
README
Laravel Swap
Swap allows you to retrieve currency exchange rates from various services such as Fixer or currencylayer and optionally cache the results.
QuickStart
Installation
$ composer require php-http/curl-client nyholm/psr7 php-http/message florianv/laravel-swap
Laravel 5.5+
If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php:
// /config/app.php 'providers' => [ Swap\Laravel\SwapServiceProvider::class ],
If you want to use the facade to log messages, add this to your facades in app.php:
'aliases' => [
'Swap' => Swap\Laravel\Facades\Swap::class
]
Copy the package config to your local config with the publish command:
$ php artisan vendor:publish --provider="Swap\Laravel\SwapServiceProvider"
Lumen
Configure the Service Provider and alias:
// /boostrap/app.php // Register the facade $app->withFacades(true, [ Swap\Laravel\Facades\Swap::class => 'Swap' ]); // Load the configuration $app->configure('swap'); // Register the service provider $app->register(Swap\Laravel\SwapServiceProvider::class);
Copy the configuration to /config/swap.php if you wish to override it.
Usage
// 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.
Sponsors 😍
We are proudly supported by the following echange rate providers offering free plans up to 1,000 requests per day:
Fixer is a simple and lightweight API for foreign exchange rates that supports up to 170 world currencies. They provide real-time rates and historical data, however, EUR is the only available base currency on the free plan.
Currencylayer provides reliable exchange rates and currency conversions for your business up to 168 world currencies. They provide real-time rates and historical data, however, USD is the only available base currency on the free plan.
Services
Here is the list of the currently implemented services:
| Service | Base Currency | Quote Currency | Historical |
|---|---|---|---|
| Fixer | EUR (free, no SSL), * (paid) | * | Yes |
| currencylayer | USD (free), * (paid) | * | Yes |
| European Central Bank | EUR | * | Yes |
| National Bank of Romania | RON | * | Yes |
| Central Bank of the Republic of Turkey | * | TRY | Yes |
| Central Bank of the Czech Republic | * | CZK | Yes |
| Central Bank of Russia | * | RUB | Yes |
| WebserviceX | * | * | No |
| 1Forge | * (free but limited or paid) | * (free but limited or paid) | No |
| Cryptonator | * Crypto (Limited standard currencies) | * Crypto (Limited standard currencies) | No |
| CurrencyDataFeed | * (free but limited or paid) | * (free but limited or paid) | No |
| Open Exchange Rates | USD (free), * (paid) | * | Yes |
| Xignite | * | * | Yes |
| Currency Converter API | * | * | Yes (free but limited or paid) |
| Array | * | * | Yes |
Credits
License
The MIT License (MIT). Please see LICENSE for more information.