A Python client for Fixer.io

Build Status Coverage Status Supports Wheel format Latest PyPI version Documentation Status Requirements Status

Fixer.io is a free JSON API for current and historical foreign exchange rates published by the European Central Bank.

The rates are updated daily around 3PM CET.

Installation

Install fixerio with:

pip install fixerio

Or with:

easy_install fixerio

Or you can get the source from GitHub at https://github.com/amatellanes/fixerio.

Usage

Get the latest foreign exchange reference rates in JSON format.

>>> from fixerio import Fixerio

>>> fxrio = Fixerio(access_key='YOUR ACCESS KEY')
>>> fxrio.latest()
'''
 {u'base': u'EUR',
 u'date': u'2016-05-27',
 u'rates': {u'AUD': 1.5483,
  u'BGN': 1.9558,
  u'BRL': 4.031,
  u'CAD': 1.456,
  u'CHF': 1.1068,
  u'CNY': 7.3281,
  u'CZK': 27.028,
  u'DKK': 7.4367,
  u'GBP': 0.76245,
  u'HKD': 8.6735,
  u'HRK': 7.4905,
  u'HUF': 314.21,
  u'IDR': 15157.25,
  u'ILS': 4.2938,
  u'INR': 74.867,
  u'JPY': 122.46,
  u'KRW': 1316.98,
  u'MXN': 20.6611,
  u'MYR': 4.5554,
  u'NOK': 9.282,
  u'NZD': 1.6586,
  u'PHP': 52.096,
  u'PLN': 4.3912,
  u'RON': 4.5034,
  u'RUB': 73.7516,
  u'SEK': 9.2673,
  u'SGD': 1.536,
  u'THB': 39.851,
  u'TRY': 3.2928,
  u'USD': 1.1168,
  u'ZAR': 17.4504}}
'''

Get historical rates for any day since 1999.

>>> import datetime
>>> from fixerio import Fixerio

>>> today = datetime.date.today()
>>> fxrio = Fixerio(access_key='YOUR ACCESS KEY')
>>> fxrio.historical_rates(today)
'''
{u'base': u'EUR',
 u'date': u'2016-05-27',
 u'rates': {u'AUD': 1.5483,
  u'BGN': 1.9558,
  u'BRL': 4.031,
  u'CAD': 1.456,
  u'CHF': 1.1068,
  u'CNY': 7.3281,
  u'CZK': 27.028,
  u'DKK': 7.4367,
  u'GBP': 0.76245,
  u'HKD': 8.6735,
  u'HRK': 7.4905,
  u'HUF': 314.21,
  u'IDR': 15157.25,
  u'ILS': 4.2938,
  u'INR': 74.867,
  u'JPY': 122.46,
  u'KRW': 1316.98,
  u'MXN': 20.6611,
  u'MYR': 4.5554,
  u'NOK': 9.282,
  u'NZD': 1.6586,
  u'PHP': 52.096,
  u'PLN': 4.3912,
  u'RON': 4.5034,
  u'RUB': 73.7516,
  u'SEK': 9.2673,
  u'SGD': 1.536,
  u'THB': 39.851,
  u'TRY': 3.2928,
  u'USD': 1.1168,
  u'ZAR': 17.4504}}
'''

Request specific exchange rates by setting the symbols parameter.

>>> from fixerio import Fixerio

>>> fxrio = Fixerio(access_key='YOUR ACCESS KEY', symbols=['USD', 'GBP'])
>>> fxrio.latest()
'''
{u'base': u'EUR',
 u'date': u'2016-05-27',
 u'rates': {u'GBP': 0.76245, u'USD': 1.1168}}
'''

>>> from fixerio import Fixerio

>>> fxrio = Fixerio(access_key='YOUR ACCESS KEY')
>>> fxrio.latest(symbols=['USD', 'GBP'])
'''
{u'base': u'EUR',
 u'date': u'2016-05-27',
 u'rates': {u'GBP': 0.76245, u'USD': 1.1168}}
'''

All exceptions that fixerio explicitly raises are fixerio.exceptions.FixerioException.

API Reference

If you are searching for information on a specific function, class, or method, this part of the documentation is for you.

client Module

class fixerio.client.Fixerio(access_key, symbols=None)[source]

Bases: object

A client for Fixer.io.

historical_rates(date, symbols=None)[source]

Get historical rates for any day since date.

Parameters:
  • date (date or str) – a date
  • symbols (list or tuple) – currency symbols to request specific exchange rates.
Returns:

the historical rates for any day since date.
Return type:

dict
Raises:

FixerioException – if any error making a request.
latest(symbols=None)[source]

Get the latest foreign exchange reference rates.

Parameters:symbols (list or tuple) – currency symbols to request specific exchange rates.
Returns:the latest foreign exchange reference rates.
Return type:dict
Raises:FixerioException – if any error making a request.

exceptions Module

exception fixerio.exceptions.FixerioException[source]

Bases: exceptions.BaseException

Common base class for all fixerio exceptions.

Release History

1.0.0-alpha (2018-06-13)

  • Update to the new Fixer endpoint.
  • Add Fixer API Access Key support.
  • Drop Changing base currency support. This option is not supported by Free Plan.
  • Drop SSL Encryption support. This option is not supported by Free Plan.

0.1.1 (2016-06-16)

  • Initial version.

Indices and tables