Python wrapper for CurrencyApi.net
Project description
CurrencyApi Python wrapper
CurrencyApi.net provides live currency rates via a REST API. A live currency feed for over 152 currencies, including physical (USD, GBP, EUR + more) and cryptos (Bitcoin, Litecoin, Ethereum + more). A JSON and XML currency api updated every 60 seconds.
Features:
- Live exchange rates (updated every 60 seconds).
- 152 currencies world currencies.
- Popular cryptocurrencies included; Bitcoin, Litecoin etc.
- Convert currencies on the fly with the convert endpoint.
- Historical currency rates back to year 2000.
- Easy to follow documentation
Signup for a free or paid account here.
This package
Python wrapper for CurrencyApi.net endpoints.
Prerequisites
- Minimum Python version 3.5
- Last tested and working on Python 3.11.5
- Free or Paid account with CurrencyApi.net
Test Coverage
- 100% coverage
Installation
Using npm:
pip install currencyapinet
then import the package with:
from currencyapinet.currency import Currency
Usage
Instantiating
currency = Currency('API_KEY')
Live rates:
result = currency.rates().get()
Example with all available methods (methods can be chained):
result = currency
.rates()
.base('USD')
.output('JSON')
.get()
Available methods for rates endpoint
Methods | Description |
---|---|
base() |
The base currency you wish you receive the currency conversions for. This will output all currency conversions for that currency. Default: USD. |
output() |
Response output in either JSON or XML. Default: JSON. |
List of available currencies:
result = currency.currencies().get()
Example with all available methods:
result = currency
.currencies()
.output('XML')
.get()
Available methods for currencies endpoint
Methods | Description |
---|---|
output() |
Response output in either JSON or XML. Default: JSON. |
Convert:
result = currency
.convert()
.from_currency('BTC')
.to_currency('USD')
.amount(100)
.get()
Available methods for convert endpoint
Methods | Description |
---|---|
amount() |
The value of the currency you want to convert from. This should be a number and can contain a decimal place. Required. |
from_currency() |
The currency you want to convert. This will be a three letter ISO 4217 currency code from one of the currencies we have rates for. Required. |
to_currency() |
The currency you want to convert the amount 'to'. Again this will be a three letter currency code from the ones we offer. Required. |
output() |
Response output in either JSON or XML. Default: JSON. |
Historical:
result = currency.history().date('2019-01-01').get()
Example with all available methods:
result = currency
.history()
.date('2019-01-01')
.base('GBP')
.output('JSON')
.get()
Available methods for historical endpoint
Methods | Description |
---|---|
date() |
The historical date you wish to receive the currency conversions for. This should be formatted as YYYY-MM-DD. Required. |
base() |
The base currency you wish you receive the currency conversions for. This will output all currency conversions for that currency. Default: USD. |
output() |
Response output in either JSON or XML. Default: JSON. |
Timeframe:
result = currency.timeframe().start_date('2019-01-01').end_date('2019-01-05').get()
Example with all available methods:
result = currency
.timeframe()
.start_date('2019-01-01')
.end_date('2019-01-05')
.base('GBP')
.output('JSON')
.get()
Available methods for timeframe endpoint
Methods | Description |
---|---|
start_date() |
The historical date you wish to receive the currency conversions from. This should be formatted as YYYY-MM-DD. Required. |
end_date() |
The historical date you wish to receive the currency conversions until. This should be formatted as YYYY-MM-DD. Required. |
base() |
The base currency you wish you receive the currency conversions for. This will output all currency conversions for that currency. Default: USD. |
output() |
Response output in either JSON or XML. Default: JSON. |
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for currencyapinet-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 829567604c0bb9041c3705df5e9ee079bc1b2793d15ea42580e7858e2b96c7ef |
|
MD5 | d5f2d93a6764fc319ad74cde589a4cda |
|
BLAKE2b-256 | 0e257e25b3a909fc3f4de8ec492c2eef7b76df50ca78f6c7552cf9e3a558b48e |