forex-python Documentation

Release 0.3.0

MicroPyramid Informatics Pvt. Ltd.

Dec 05, 2018

 Contents

1 Features: 3
1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Usage Examples: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3 currency source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

i
ii
 forex-python Documentation, Release 0.3.0

Free Foreign exchange rates, bitcoin prices and currency conversion.

Contents 1
forex-python Documentation, Release 0.3.0

2 Contents
 CHAPTER 1

Features:

• List all currency rates.

• BitCoin price for all curuncies.
• Converting amount to BitCoins.
• Get historical rates for any day since 1999.
• Conversion rate for one currency(ex; USD to INR).
• Convert amount from one currency to other.(‘USD 10$’ to INR)
• Currency Symbols
• Currency names
Contents:

1.1 Installation

The recommended way to install the Debug Toolbar is via pip:

$ pip install forex-python

Install from development branch:

$ pip install git+https://github.com/MicroPyramid/forex-python.git

Note: forex-python uses requests to make API calls.

3
forex-python Documentation, Release 0.3.0

1.2 Usage Examples:

1.2.1 Currency Rates

1. list all latest currency rates for “USD”::

>>> from forex_python.converter import CurrencyRates

>>> c = CurrencyRates()
>>> c.get_rates('USD') # you can directly call get_rates('USD')
{u'IDR': 13625.0, u'BGN': 1.7433, u'ILS': 3.8794, u'GBP': 0.68641, u'DKK': 6.
˓→6289, u'CAD': 1.3106, u'JPY': 110.36, u'HUF': 282.36, u'RON': 4.0162, u'MYR

˓→': 4.081, u'SEK': 8.3419, u'SGD': 1.3815, u'HKD': 7.7673, u'AUD': 1.3833, u

˓→'CHF': 0.99144, u'KRW': 1187.3, u'CNY': 6.5475, u'TRY': 2.9839, u'HRK': 6.

˓→6731, u'NZD': 1.4777, u'THB': 35.73, u'EUR': 0.89135, u'NOK': 8.3212, u'RUB

˓→': 66.774, u'INR': 67.473, u'MXN': 18.41, u'CZK': 24.089, u'BRL': 3.5473, u

˓→'PLN': 3.94, u'PHP': 46.775, u'ZAR': 15.747}

2. List all Currency rates for “USD” on 2012-09-05::

>>> date_obj
datetime.datetime(2014, 5, 23, 18, 36, 28, 151012)
>>> c.get_rates('USD', date_obj) # same as get_rates('USD', date_obj)
{u'IDR': 11612.0, u'BGN': 1.4349, u'ILS': 3.4861, u'GBP': 0.5938, u'DKK': 5.
˓→4762, u'CAD': 1.0901, u'JPY': 101.92, u'HUF': 222.66, u'RON': 3.2359, u'MYR

˓→': 3.2101, u'EUR': 0.73368, u'SEK': 6.6471, u'SGD': 1.2527, u'HKD': 7.7519,

˓→u'AUD': 1.0845, u'CHF': 0.89582, u'KRW': 1024.9, u'CNY': 6.2377, u'TRY': 2.

˓→0888, u'HRK': 5.5751, u'NZD': 1.1707, u'THB': 32.6, u'LTL': 2.5332, u'NOK':

˓→5.9652, u'RUB': 34.122, u'INR': 58.509, u'MXN': 12.893, u'CZK': 20.131, u

˓→'BRL': 2.2178, u'PLN': 3.0544, u'PHP': 43.721, u'ZAR': 10.356}

3. Get conversion rate from USD to INR::

>>> c.get_rate('USD', 'INR') # same as get_rate('USD', 'INR')

67.473 # return type float

4. Get conversion rate from USD to INR on 2014-05-23::

>>> date_obj
datetime.datetime(2014, 5, 23, 18, 36, 28, 151012)
>>> c.get_rate('USD', 'INR', date_obj) # get_rate('USD', 'INR', date_obj)
58.509

5. Convert amount from USD to INR::

>>> c.convert('USD', 'INR', 10) # convert('USD', 'INR', 10)

674.73

6. Convert amount from USD to INR based on 2014-05-23 exchange rates::

>>> date_obj
datetime.datetime(2014, 5, 23, 18, 36, 28, 151012)
>>> c.convert('USD', 'INR', 10, date_obj)
585.09

7. Force use of Decimal::

4 Chapter 1. Features:
 forex-python Documentation, Release 0.3.0

>>> from forex_python.converter import CurrencyRates

>>> c = CurrencyRates(force_decimal=True)
>>> c.convert('USD', 'INR', Decimal('10.45'))
Decimal('705.09')
>>> c.convert('USD', 'INR', 10)
DecimalFloatMismatchError: convert requires amount parameter is of type
˓→Decimal when use_decimal=True

8. Detect use of Decimal::

>>> from forex_python.converter import CurrencyRates

>>> c = CurrencyRates()
>>> c.convert('USD', 'INR', Decimal('10.45'))
Decimal('705.09')
>>> c.convert('USD', 'INR', 10)
674.73

1.2.2 Bitcoin Prices:

1. Get latest price of one Bitcoin::

>>> from forex_python.bitcoin import BtcConverter

>>> b = BtcConverter() # add "force_decimal=True" parmeter to get Decimal
˓→rates

>>> b.get_latest_price('EUR') # you can directly call get_latest_price('EUR

˓→')

476.5225 # return type float

2. Get price of Bitcoin based on prevois date::

>>> date_obj
datetime.datetime(2016, 5, 18, 19, 39, 36, 815417)
>>> b.get_previous_price('USD', date_obj) # get_previous_price('USD', date_
˓→obj)

453.378

3. Convert Amout to bitcoins::

>>> b.convert_to_btc(5000, 'USD') # convert_to_btc(5000, 'USD')

9.36345369116708

4. Convert Amount to bitcoins based on previous date prices::

>>> date_obj
datetime.datetime(2016, 5, 18, 19, 39, 36, 815417)
>>> b.convert_to_btc_on(5000, 'USD', date_obj) # convert_to_btc_on(5000,
˓→'USD', date_obj)

11.028325150316071

5. Convert Bitcoins to valid currency amount based on lates price::

>>> b.convert_btc_to_cur(1.25, 'USD') # convert_btc_to_cur(1.25, 'USD')

668.1012499999999

6. Convert Bitcoins to valid currency amount based on previous date price::

1.2. Usage Examples: 5

forex-python Documentation, Release 0.3.0

>>> date_obj
datetime.datetime(2016, 5, 18, 19, 39, 36, 815417)
>>> b.convert_btc_to_cur_on(1.25, 'EUR', date_obj)
504.23625000000004

7. Get list of prices list for given date range::

>>> start_date
datetime.datetime(2016, 5, 18, 19, 39, 36, 815417)
>>> end_date
datetime.datetime(2016, 5, 23, 19, 39, 36, 815417)
>>> b.get_previous_price_list('INR', start_date, end_date) # get_previous_
˓→price_list('INR', start_date, end_date)

{u'2016-05-19': 29371.7579, u'2016-05-18': 30402.3169, u'2016-05-22': 29586.

˓→3631, u'2016-05-23': 29925.3272, u'2016-05-20': 29864.0256, u'2016-05-21':

˓→29884.7449}

8. Force use of Decimal::

>>> from forex_python.bitcoin import BtcConverter

>>> b = BtcConverter(force_decimal=True)
>>> b.get_latest_price('EUR') # you can directly call get_latest_price('EUR
˓→')

Decimal('942.245000000000004547') # return type Decimal

9. Get Bitcoin symbol::

>>> print(b.get_symbol()) # get_btc_symbol()

฿

1.2.3 Currency Symbols & Codes

1. Get Currency symbol Using currency code::

>>> from forex_python.converter import CurrencyCodes

>>> c = CurrencyCodes()
>>> c.get_symbol('GBP')
u'\xa3'
>>> print c.get_symbol('GBP')
£
>>> print c.get_symbol('EUR')
C

2. Get Currency Name using currency code::

>>> c.get_currency_name('EUR')
u'European Euro'
>>> c.get_currency_name('INR')
u'Indian rupee'

6 Chapter 1. Features:
 forex-python Documentation, Release 0.3.0

1.3 currency source

1.3.1 https://ratesapi.io

https://ratesapi.io is a free API for current and historical foreign exchange rates published by European Central Bank.
The rates are updated daily 3PM CET.

1.3.2 List of Supported Currency codes.

Updated On 2018-05-08
|EUR - Euro Member Countries |IDR - Indonesia Rupiah |BGN - Bulgaria Lev |ILS - Israel Shekel |GBP - United
Kingdom Pound |DKK - Denmark Krone |CAD - Canada Dollar |JPY - Japan Yen |HUF - Hungary Forint |RON -
Romania New Leu |MYR - Malaysia Ringgit |SEK - Sweden Krona |SGD - Singapore Dollar |HKD - Hong Kong
Dollar |AUD - Australia Dollar |CHF - Switzerland Franc |KRW - Korea (South) Won |CNY - China Yuan Renminbi
|TRY - Turkey Lira |HRK - Croatia Kuna |NZD - New Zealand Dollar |THB - Thailand Baht |USD - United States
Dollar |NOK - Norway Krone |RUB - Russia Ruble |INR - India Rupee |MXN - Mexico Peso |CZK - Czech Republic
Koruna |BRL - Brazil Real |PLN - Poland Zloty |PHP - Philippines Peso |ZAR - South Africa Rand

1.3.3 Bitcoin Prices:

Bitcoin prices calculated every minute from CoinDesk API.

1.3. currency source 7