isaaclm / fixerio-client

A Python client for the fixer.io foreign exchange API implementing all subscription levels

A Python client for fixer.io

fixer.io is a simple and lightweight JSON API for current and historical foreign exchange (forex) rates. Fixer.io:

This library contains clients for each tier of the fixer.io subscriptions, from free up to professional plus. Each tier extends the prior, so if you upgrade your subscription, you can simply swap out your client by changing 1 line of code.

Installation

You can get the source from GitHub at https://github.com/isaaclm/fixerio-client.

Usage

Get the latest foreign exchange reference rates in JSON format. You can request specific rates by specifying the symbols as in this example.

>>> import fixerio

>>> fxrio = fixerio.FreeClient(access_key='YOUR FREE ACCESS KEY')
>>> fxrio.get_latest(symbols=["USD", "CNY", "CAD", "JPY", "GBP", "CHF"])
'''
 {
   u'rates':
   {
     u'USD': 1.050282,
     u'CNY': 7.678637,
     u'CAD': 1.419047,
     u'JPY': 157.141116,
     u'GBP': 0.866294,
     u'CHF': 0.966654
   },
   u'success': True,
   u'timestamp': 1695832924,
   u'base': u'EUR',
   u'date': u'2023-09-27'
 }
'''

If you don't specify the symbols you will request all rates for your base currency.

Note that the only available base currency on the free subscription is 'EUR'.

Get the list of available currencies.

>>> import fixerio

>>> fxrio = fixerio.FreeClient(access_key='YOUR FREE ACCESS KEY')
>>> fxrio.get_symbols()
'''
 {
   u'symbols':
   {
     u'AED': u'United Arab Emirates Dirham',
     u'AFN': u'Afghan Afghani',
     u'ALL': u'Albanian Lek',
     ...
     u'ZWL': u'Zimbabwean Dollar'
   },
   u'success': True
 }
'''

Get historical rates for any day since 1999.

>>> import fixerio
>>> from datetime import date, timedelta

>>> yesterday = date.today() - timedelta(days=1)
>>> fxrio = fixerio.FreeClient(access_key='YOUR FREE ACCESS KEY')
>>> fxrio.historical_rates(yesterday)
'''
 {
   u'rates':
   {
     u'USD': 1.05692,
     u'GBP': 0.870168
   },
   u'success': True,
   u'timestamp': 1695772799,
   u'historical': True,
   u'base': u'EUR',
   u'date': u'2023-09-26'
 }
'''

Get the latest EUR and GBP rates with a USD base with a basic subscription.

>>> import fixerio
>>> from datetime import date, timedelta

>>> yesterday = date.today() - timedelta(days=1)
>>> fxrio = fixerio.BasicClient(access_key='YOUR BASIC ACCESS KEY')
>>> fxrio.get_latest(symbols=["EUR", "GBP"], base="USD")

Get the a timeseries of CHN with a USD base for the first half of 2023 with a professional subscription.

>>> import fixerio
>>> fxrio = fixerio.ProfessionalClient(access_key='YOUR PROFESSIONAL ACCESS KEY')
>>> fxrio.get_time_series("2023-01-01", "2023-06-01", symbols=["CNY"], base="USD")

Get the price fluctuation of all currencies with a USD base for the first half of 2023 with a professional plus subscription.

>>> import fixerio
>>> fxrio = fixerio.ProfessionalPlusClient(access_key='YOUR PROFESSIONAL PLUS ACCESS KEY')
>>> fxrio.get_fluctuation("2023-01-01", "2023-06-01", base="USD")

Useful Links -----

Fixer.io: https://fixer.io/

Fixer.io documentation: https://fixer.io/documentation