Python wrapper for the MX Atrium API
Switch branches/tags
Clone or download
newellista Merge pull request #3 from mxenabled/add-categorize-transactions-endp…
…oint

Add categorize_and_describe endpoint
Latest commit 52b4e37 Oct 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
atrium fix typo Oct 10, 2018
examples Add categorize_and_describe endpoint Oct 10, 2018
.gitignore fix typo Oct 10, 2018
LICENSE.txt first commit Nov 1, 2017
README.md updated examples and objects Nov 27, 2017

README.md

Atrium-Python

A Python wrapper for the MX Atrium API. In order to make requests, you will need to sign up for the MX Atrium API and get a MX-API-KEY and a MX-CLIENT-ID.

Usage

Add the atrium module to your source code's directory and import into your source code file with the following

from atriumclient import AtriumClient

Then configure your instance with the following. (The ENVIRONMENT will be either vestibule.mx.com for the development environment or atrium.mx.com for the production environment.)

atriumClient = AtriumClient("ENVIRONMENT", "YOUR_MX_API_KEY", "YOUR_MX_CLIENT_ID")

Then start using class methods to make calls to the Atrium API for data. See the full Atrium documentation for more details.

# import AtriumClient wrapper class
from atriumclient import AtriumClient

# Configure AtriumClient
atriumClient = AtriumClient("ENVIRONMENT", "YOUR_MX_API_KEY", "YOUR_MX_CLIENT_ID")

# Now begin making Atrium calls
atriumClient.createUser(identifier = "UniqueID") # Create a user, etc...

Examples

The /examples directory contains various workflows and code snippets. You will first need to modify the line shown below in each example with the environment, YOUR-MX-API-KEY, and YOUR-MX-CLIENT-ID before running.

atriumClient = AtriumClient("ENVIRONMENT", "YOUR_MX_API_KEY", "YOUR_MX_CLIENT_ID")