@ftim/mint-client

mint-client is an unofficial TypeScript library facilitating authentication and requests to the Intuit Mint platform
Explore the docs »

Report Bug · Request Feature

Installation

To install the mint-client library, run npm install --save @ftim/mint-client

Usage

Example:

import MintClient, { EOTPType, OTPProviders } from '@ftim/mint-client';

const client = new MintClient({
  username: 'supersaver',
  password: 'supersecurepassword',
  otpProviders: {
    [EOTPType.CAPTCHA_TOKEN]: new OTPProviders.CaptchaOTPProvider(),
    [EOTPType.TOTP]: new OTPProviders.TOTPProvider('TOTPSECRET'),
    [EOTPType.SMS_OTP]: new OTPProviders.UserInputOTPProvider('Please enter your SMS OTP token:'),
    [EOTPType.EMAIL_OTP]: new OTPProviders.EmailOTPProvider({
      host: 'imap.gmail.com',
      port: 993,
      auth: {
        user: '[e-mail]',
        pass: 'supersecurepassword',
      },
    }),
  },
});

See here for all available client methods.

Roadmap

• [x] Generalize OTPProvider Interface
• [x] Implement retrieving history data (net worth, spending)
• [x] Implement retrieving budget statistics
• [ ] Implement logout method