Skip to content

Aerrus-zz/xecd-rates-client-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

XE Currency Data Client - Python

XE.com Inc. is the World's Trusted Currency Authority. This project provides an SDK to interface with our XE Currency Data (XECD) product.

XE Currency Data is a REST API that gives you access to daily or live rates and historic mid-market conversion rates between all of our supported currencies.

You will need an api key and secret to use this sdk. Sign up for a free trial or register for a full account.

This client will work with both python2 and python3.

Installation

The preferred way to install this package is through Github.

TODO
pip install >github link<
pip install >package name when published to pip<>

This package follows semantic versioning.

Usage

from XecdClient import XecdClient

xecd = XecdClient('accountId', 'apiKey')


response = xecd.account_info()
#do stuff with response
response = xecd.currencies()
response = xecd.convert_from("EUR", "CAD", 55)
response = xecd.convert_to("RUB", "CAD", 55)
response = xecd.historic_rate("2016-12-25", "12:34", "EUR", "CAD", 55)
response = xecd.historic_rate_period(55, "EUR", "RUB", "2016-02-28T12:00", "2016-03-03T12:00")
response = xecd.monthly_average(55, "CAD", "EUR", 2017, 5)

Documentation

Technical Specifications

Contributing

xecd_rates_client_python is an open-source project. Submit a pull request to contribute!

Testing

python3 -m test.UnitTest
python3 -m test.IntegrationTest
python -m test.IntegrationTest

Note: the UnitTest must be ran with python3 due to its use of unittest.mock (which is not present as of python2.7). Despite this, the client itself is usable with both python 2 and 3.

Security Issues

If you discover a security vulnerability within this package, please DO NOT publish it publicly. Instead, contact us at security [at] xe.com. We will follow up with you as soon as possible.

About Us

XE.com Inc. is The World's Trusted Currency Authority. Development of this project is led by the XE.com Inc. Development Team and supported by the open-source community.

About

REST Client

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages