mrzard/open-exchange-rates-service

OpenExchangeRates API exposure

v1.1.2 2017-12-01 14:51 UTC

Requires

• php: >=5.6.0

Requires (Dev)

• guzzlehttp/guzzle: ~6
• phpunit/phpunit: >=4.0.0 <6.0.0

Suggests

• guzzlehttp/guzzle: ~6

MIT

• Gonzalo Míguez

• currency
• openexchangerates
• exchange

README

This service will help you use OpenExchangeRates in your project

Installation

Use composer to require and install the service

$ php composer.phar require mrzard/open-exchange-rates-service ~1.0.0

Configuration

When creating an instance of the service, you will have to provide the basic data needed for accessing the OpenExchangeRates API and a HTTP client compatible with HttpClientInterface like GuzzleHttp\Client

    use Mrzard\OpenExchangeRates\Service\OpenExchangeRatesService;
    use GuzzleHttp\Client;
    ...

    $apiOptions = array(
        'https' => false,
        'base_currency' => 'USD'
    );

    new OpenExchangeRatesService(
        $openExchangeRatesApiId, // your id from openExchangeRatesApi
        $apiOptions,
        new Client()
    );
    ...

If you're using a free version, you won't need to change the https or base_currency as they only work for Enterprise/Unlimited accounts

Note on HTTP client

compatible in current context means that the client MUST have methods with next signatures:

public HttpRequestInterface request(string method, string url = null, array $options = []);

public HttpResponseInterface send(HttpRequestInterface request);

Also wrapper doesn't require returned values to implement that interface, but MUST be also compatible

Usage

Free features

Get latest exchange rates

    /**
     * Get the latest exchange rates
     *
     * @param array  $symbols Currency codes to get the rates for. Default all
     * @param string $base    Base currency, default NULL (gets it from config)
     *
     * @return array
     */
    public function getLatest($symbols = array, $base = null)
    {
    }

Only use the $symbols and $base parameters if you have an Enterprise or Unlimited plan.

Output:

    array (size=5)

          'disclaimer' => string 'Exchange rates...'

          'license' => string 'Data sourced from...'

          'timestamp' => int 1395396061

          'base' => string 'USD' (length=3)

          'rates' =>

                array (size=166)

                  'AED' => float 3.672721

                  'AFN' => float 56.747225

                  'ALL' => float 101.7573

                  'AMD' => float 417.366998

                  ...
            )
    )

Get available currencies

    /**
     * Gets a list of all available currencies
     *
     * @return array with keys = ISO codes, content = Currency Name
     */
    public function getCurrencies()
    {
    }

Output:

    array (size=5)

          'AED' => 'United Arab Emirates Dirham'

          'AFN' => 'Afghan Afghani'

          'ALL' => 'Albanian Lek'

          'AMD' => 'Armenian Dram'

          'ANG' => 'Netherlands Antillean Guilder'

          ...

    )

Get historical data for a date

    /**
     * Get historical data
     *
     * @param \DateTime $date
     * @param array  $symbols array of currency codes to get the rates for.
     *                        Default empty (all currencies)
     * @param string $base    Base currency, default NULL (gets it from config)
     *
     */
    public function getHistorical(\DateTime $date)
    {
    }

Only use the $symbols and $base parameters if you have a Developer, Enterprise or Unlimited plan.

Output:

    array (size=5)

        'disclaimer' => string 'Exchange rates...'

        'license' => string 'Data sourced from...'

        'timestamp' => int 1388617200

        'base' => string 'USD' (length=3)

        'rates' =>

            array (size=166)

                'AED' => float 3.672524

                'AFN' => float 56.0846

                'ALL' => float 102.06575

                'AMD' => float 408.448002

                'ANG' => float 1.78902

                'AOA' => float 97.598401

                'ARS' => float 6.51658

                'AUD' => float 1.124795

                'AWG' => float 1.789775

                'AZN' => float 0.7841

                'BAM' => float 1.421715

                'BBD' => int 2
          ...
        )
    )

Developer / Unlimited features

Get the latest exchange rates, limiting the return array

    $openExchangeRatesService->getLatest(array('EUR', 'USD', 'COP'));

Output:

    array (size=5)

          'disclaimer' => string 'Exchange rates ...'

          'license' => string 'Data sourced...'

          'timestamp' => int 1395396061

          'base' => string 'USD' (length=3)

          'rates' =>

                array (size=3)

                  'EUR' => ...,

                  'USD' => ...,

                  'COP' => ...

                )

    )

You can also change the base currency used to get the latest exchange rates with the second parameter

Directly convert a quantity between currencies

    $openExchangeRatesService->convert(10, 'USD', 'EUR');