mx-atrium
TypeScript icon, indicating that this package has built-in type declarations

2.11.6 • Public • Published

MX API

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.

Installation & Usage

Install dependencies

npm install mx-atrium

Example Usage

Please see docs directory for additional endpoint examples

var atrium = require('mx-atrium');

var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID", "https://vestibule.mx.com");

var accountGuid = "ACT-123"; // string | The unique identifier for an `account`.
var userGuid = "USR-123"; // string | The unique identifier for a `user`.
var fromDate = "2016-09-20"; // string | Filter transactions from this date. (optional)
var toDate = "2016-10-20"; // string | Filter transactions to this date. (optional)
var page = 1; // number | Specify current page. (optional)
var recordsPerPage = 12; // number | Specify records per page. (optional)

var response = client.accounts.listAccountTransactions(accountGuid, userGuid, fromDate, toDate, page, recordsPerPage);

response.then(function(value) {
  console.log(value);
});

Development

Install dependencies

npm install

Generate JavaScript file

npm run build

This will generate atrium.js and atrium.d.ts

Readme

Keywords

none

Package Sidebar

Install

npm i mx-atrium

Weekly Downloads

85

Version

2.11.6

License

MIT

Unpacked Size

391 kB

Total Files

6

Last publish

Collaborators

  • whiteinge
  • cerinman
  • paniclater
  • sambev
  • brettmortensen