Official Python wrapper for energypriceapi.com
Project description
EnergypriceAPI
energypriceapi is the official Python API wrapper for EnergypriceAPI.com. This allows you to quickly integrate our foreign exchange rate API and currency conversion API into your application. Check https://energypriceapi.com documentation for more information.
Installation
Install the latest release with:
pip install energypriceapi
Usage
from energypriceapi.client import Client
api_key = 'SET_YOUR_API_KEY_HERE'
client = Client(api_key)
Documentation
fetchSymbols()
client.fetchSymbols()
fetchLive(base, currencies)
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=['BRENT','GASOLINE','NATURALGAS','WTI'])
fetchHistorical(date, base, currencies)
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=['BRENT','GASOLINE','NATURALGAS','WTI'])
convert(from_currency, to_currency, amount, date)
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')
timeframe(start_date, end_date, base, currencies)
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=['BRENT','GASOLINE','NATURALGAS','WTI'])
change(start_date, end_date, base, currencies)
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=['BRENT','GASOLINE','NATURALGAS','WTI'])
FAQ
-
How do I get an API Key?
Free API Keys are available here.
-
I want more information
Checkout our FAQs here.
Support
For support, get in touch using this form.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
energypriceapi-1.0.3.tar.gz
(3.4 kB
view hashes)
Built Distribution
Close
Hashes for energypriceapi-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 032adbee6fe14e04a52263693598dbda480beff05268ad1fbf3faef44b5d9d05 |
|
MD5 | ac27ab47249bca92604bab4ad7f09e60 |
|
BLAKE2b-256 | 0ec1bcea3f408127d4d64bf02f923f425db4ec211f4bfb3f829992ad9a36395a |