boxr 1.0.1

Install

$ pip install boxr

Usage

Boxr maps 1:1 with the OXR api documented here: https://docs.openexchangerates.org/docs/. This means https://openexchangerates.org/api/latest.json maps to boxr.latest(), and https://openexchangerates.org/api/historical/:date.json maps to boxr.historical(date).

In short

• Routes map to function names, e.g. /latest.json -> latest()

• Path params map to function arguments, e.g. /historical/:date.json -> historical(date)

• Query params map to keyword arguments, e.g. /time-series.json?start=2017-01-01&end=2017-01-05 -> time_series(start="2017-01-01", end='2017-01-05')

Also note that all endpoints return requests response objects, so things like validation of request or formatting the response can be done by interacting with the response object.

Example usage

from boxr import Boxr

boxr = Boxr(app_id='your_app_id')

# All calls return a `requests` Response object
latest = boxr.latest()

# And thus we get the json
result = latest.json()

Contributing

I would like this package to always be up to date with the OXR http API. If this is someday not the case please open a Pull Request or open an issue about the noncompliance.