atrium

The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification. Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes. Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access.

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install atrium

Then import the package:

import atrium

Example Usage

Please see docs directory for additional endpoint examples

from __future__ import print_function
import time
import atrium
from atrium.rest import ApiException
from pprint import pprint

# create an instance of the AtriumClient
client = atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID", "https://vestibule.mx.com")

account_guid = "ACT-123" # str | The unique identifier for an `account`.
user_guid = "USR-123" # str | The unique identifier for a `user`.
from_date = "2016-09-20" # str | Filter transactions from this date. (optional)
to_date = "2016-10-20" # str | Filter transactions to this date. (optional)
page = 1 # int | Specify current page. (optional)
records_per_page = 12 # int | Specify records per page. (optional)

try:
    # List account transactions
    response = client.accounts.list_account_transactions(account_guid, user_guid, from_date=from_date, to_date=to_date, page=page, records_per_page=records_per_page)
    pprint(response)
except ApiException as e:
    print("Exception when calling AccountsApi->list_account_transactions: %s\n" % e)

Documentation for API Endpoints

Class	Method	HTTP request	Description
AccountsApi	list_account_transactions	GET /users/{user_guid}/accounts/{account_guid}/transactions	List account transactions
AccountsApi	list_user_accounts	GET /users/{user_guid}/accounts	List accounts for a user
AccountsApi	read_account	GET /users/{user_guid}/accounts/{account_guid}	Read an account
AccountsApi	read_account_by_member_guid	GET /users/{user_guid}/members/{member_guid}/accounts/{account_guid}	Read an account
ConnectWidgetApi	get_connect_widget	POST /users/{user_guid}/connect_widget_url	Embedding in a website
HoldingsApi	list_holdings	GET /users/{user_guid}/holdings	List holdings
HoldingsApi	list_holdings_by_account	GET /users/{user_guid}/accounts/{account_guid}/holdings	List holdings by account
HoldingsApi	list_holdings_by_member	GET /users/{user_guid}/members/{member_guid}/holdings	List holdings by member
HoldingsApi	read_holding	GET /users/{user_guid}/holdings/{holding_guid}	Read holding
IdentityApi	identify_member	POST /users/{user_guid}/members/{member_guid}/identify	Identify
IdentityApi	list_account_owners	GET /users/{user_guid}/members/{member_guid}/account_owners	List member account owners
InstitutionsApi	list_institutions	GET /institutions	List institutions
InstitutionsApi	read_institution	GET /institutions/{institution_code}	Read institution
InstitutionsApi	read_institution_credentials	GET /institutions/{institution_code}/credentials	Read institution credentials
MembersApi	aggregate_member	POST /users/{user_guid}/members/{member_guid}/aggregate	Aggregate member
MembersApi	aggregate_member_balances	POST /users/{user_guid}/members/{member_guid}/balance	Aggregate member account balances
MembersApi	create_member	POST /users/{user_guid}/members	Create member
MembersApi	delete_member	DELETE /users/{user_guid}/members/{member_guid}	Delete member
MembersApi	extend_history	POST /users/{user_guid}/members/{member_guid}/extend_history	Extend history
MembersApi	list_member_accounts	GET /users/{user_guid}/members/{member_guid}/accounts	List member accounts
MembersApi	list_member_credentials	GET /users/{user_guid}/members/{member_guid}/credentials	List member credentials
MembersApi	list_member_mfa_challenges	GET /users/{user_guid}/members/{member_guid}/challenges	List member MFA challenges
MembersApi	list_member_transactions	GET /users/{user_guid}/members/{member_guid}/transactions	List member transactions
MembersApi	list_members	GET /users/{user_guid}/members	List members
MembersApi	read_member	GET /users/{user_guid}/members/{member_guid}	Read member
MembersApi	read_member_status	GET /users/{user_guid}/members/{member_guid}/status	Read member connection status
MembersApi	resume_member	PUT /users/{user_guid}/members/{member_guid}/resume	Resume aggregation from MFA
MembersApi	update_member	PUT /users/{user_guid}/members/{member_guid}	Update member
MerchantsApi	read_merchant	GET /merchants/{merchant_guid}	Read merchant
StatementsApi	download_statement_pdf	GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf	Download statement PDF
StatementsApi	fetch_statements	POST /users/{user_guid}/members/{member_guid}/fetch_statements	Fetch statements
StatementsApi	list_member_statements	GET /users/{user_guid}/members/{member_guid}/statements	List member statements
StatementsApi	read_member_statement	GET /users/{user_guid}/members/{member_guid}/statements/{statement_guid}	Read statement JSON
TransactionsApi	cleanse_and_categorize_transactions	POST /transactions/cleanse_and_categorize	Categorize transactions
TransactionsApi	list_user_transactions	GET /users/{user_guid}/transactions	List transactions for a user
TransactionsApi	read_transaction	GET /users/{user_guid}/transactions/{transaction_guid}	Read a transaction
UsersApi	create_user	POST /users	Create user
UsersApi	delete_user	DELETE /users/{user_guid}	Delete user
UsersApi	list_users	GET /users	List users
UsersApi	read_user	GET /users/{user_guid}	Read user
UsersApi	update_user	PUT /users/{user_guid}	Update user
VerificationApi	list_account_numbers	GET /users/{user_guid}/members/{member_guid}/account_numbers	Read account numbers
VerificationApi	list_account_numbers_by_account	GET /users/{user_guid}/accounts/{account_guid}/account_numbers	Read account numbers by account GUID
VerificationApi	verify_member	POST /users/{user_guid}/members/{member_guid}/verify	Verify