New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

mx-atrium

Package Overview
Dependencies
Maintainers
4
Versions
32
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mx-atrium - npm Package Compare versions

Comparing version 0.0.10 to 2.4.2

atrium.d.ts

45

package.json
{
"name": "mx-atrium",
"version": "0.0.10",
"description": "Node wrapper for the MX Atrium API",
"main": "index.js",
"scripts": {
"test": "eslint index.js"
},
"author": "MX",
"license": "MIT",
"bugs": {
"url": "https://github.com/mxenabled/mx-atrium-node/issues"
},
"homepage": "https://github.com/mxenabled/mx-atrium-node",
"dependencies": {
"es6-promise": "^4.0.5",
"isomorphic-fetch": "^2.2.1"
},
"devDependencies": {
"eslint": "^3.7.1"
}
"name": "mx-atrium",
"version": "2.4.2",
"description": "NodeJS client for mx-atrium-node",
"repository": "mxenabled/mx-atrium-node",
"main": "api.js",
"types": "api.d.ts",
"scripts": {
"clean": "rm -Rf node_modules/ *.js",
"build": "tsc",
"test": "npm run build && node client.js"
},
"author": "MX",
"license": "MIT",
"dependencies": {
"bluebird": "^3.5.0",
"request": "^2.81.0",
"@types/bluebird": "*",
"@types/request": "*"
},
"devDependencies": {
"typescript": "^2.4.2"
},
"publishConfig": {
"registry": "https://registry.npmjs.org/"
}
}

@@ -1,48 +0,37 @@

# MX Atrium
[![npm version](https://badge.fury.io/js/mx-atrium.svg)](http://badge.fury.io/js/mx-atrium) [![Build Status](https://travis-ci.org/mxenabled/mx-atrium-node.svg?branch=master)](https://travis-ci.org/mxenabled/mx-atrium-node)
# 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.
## Description
This is a Node wrapper for the [MX Atrium API](https://atrium.mx.com). It is intended to be used as a helper for the implementation of a proxy server. To get an API key and Client ID, [click here](https://atrium.mx.com/developers/sign_up).
## Installation & Usage
## Installation
### Install dependencies
```sh
npm install
```
npm install mx-atrium
```
## Usage
### Generate JavaScript file
```sh
npm run build
```
const Atrium = require('mx-atrium');
const AtriumClient = new Atrium.Client('API_KEY', 'CLIENT_ID', Atrium.environments.sand);
```
## Example Usage
Sample Express.js route
```
app.get('/institutions', (request, response) => {
AtriumClient.listInstitutions(request)
.then(json => {
response.json(json);
});
});
```
Please see `docs` directory for additional endpoint examples
For a complete express.js server example, [click here](https://github.com/mxenabled/mx-atrium-express).
```javascript
var atrium = require('./atrium.js');
## Helpers
var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID");
There are two constants returned with the Atrium instance, `endpoints` and `environments`.
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)
#### Atrium.environments
This returns a `sand` and `production` URL that must be passed to the new client.
var response = client.accounts.listAccountTransactions(accountGuid, userGuid, fromDate, toDate, page, recordsPerPage);
#### Atrium.endpoints
This returns an array of objects that can be used to build routes for the server.
Sample object
response.then(function(value) {
console.log(value);
});
```
{
method: 'post',
url: '/users',
clientMethod: 'createUser'
}
```
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc