forexrateapi is the official Python API wrapper for ForexRateAPI.com. This allows you to quickly integrate our foreign exchange rate API and currency conversion API into your application. Check https://forexrateapi.com documentation for more information.
Install the latest release with:
pip install forexrateapi
from forexrateapi.client import Client
api_key = 'SET_YOUR_API_KEY_HERE'
client = Client(api_key)
client.fetchSymbols()
base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<List<string>> Optional. Pass in an list of currencies to return values for.
client.fetchLive(base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
date
<string> Required. Pass in a string with formatYYYY-MM-DD
base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<List<string>> Optional. Pass in an list of currencies to return values for.
client.fetchHistorical(date='2021-04-05', base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
from_currency
<string> Optional. Pass in a base currency, defaults to USD.to_currency
<string> Required. Specify currency you would like to convert to.amount
<number> Required. The amount to convert.date
<string> Optional. Specify date to use historical midpoint value for conversion with formatYYYY-MM-DD
. Otherwise, it will use live exchange rate date if value not passed in.
client.convert(from_currency='USD', to_currency='EUR', amount=100, date='2021-04-05')
start_date
<string> Required. Specify the start date of your timeframe using the formatYYYY-MM-DD
.end_date
<string> Required. Specify the end date of your timeframe using the formatYYYY-MM-DD
.base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<List<string>> Optional. Pass in an list of currencies to return values for.
client.timeframe(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
start_date
<string> Required. Specify the start date of your timeframe using the formatYYYY-MM-DD
.end_date
<string> Required. Specify the end date of your timeframe using the formatYYYY-MM-DD
.base
<string> Optional. Pass in a base currency, defaults to USD.currencies
<List<string>> Optional. Pass in an list of currencies to return values for.
client.change(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['AUD', 'CAD', 'GBP', 'JPY'])
-
How do I get an API Key?
Free API Keys are available here.
-
I want more information
Checkout our FAQs here.
For support, get in touch using this form.