@client-zone/starling

A simple, isomorphic client for the Starling Bank API. Supports Personal Access Token auth, which is typically all you need for managing your own accounts. Create a PAT here.

See here for the API docs. Some example scripts here.

Example

First, create a shell file (e.g. starling-variables.sh) setting your credentials as environment variables. Storing tokens privately in a local file is preferable to passing them into your scripts every time or worse, hard-coding them.

export SB_TOKEN="er87tret7rew85wert9rt etc"
export SB_ACCOUNT="account-guid-account-guid"

Load the stored environment variables.

source starling-variables.sh

Run a simple NodeJs script to fetch your account balance.

import StarlingBank from '@client-zone/starling'

const accessToken = process.env.SB_TOKEN
const accountId = process.env.SB_ACCOUNT

if (!(accessToken && accountId)) {
  throw new Error('accessToken and accountId required')
}

const bank = new StarlingBank({ accessToken })
const balance = await bank.balance(accountId)

console.log(balance)

Output.

{
  clearedBalance: { currency: 'GBP', minorUnits: 100 },
  effectiveBalance: { currency: 'GBP', minorUnits: 100 },
  pendingTransactions: { currency: 'GBP', minorUnits: 0 },
  acceptedOverdraft: { currency: 'GBP', minorUnits: 0 },
  amount: { currency: 'GBP', minorUnits: 100 },
  totalClearedBalance: { currency: 'GBP', minorUnits: 100 },
  totalEffectiveBalance: { currency: 'GBP', minorUnits: 100 }
}

Install

$ npm install @client-zone/starling

Load Anywhere

From a NodeJs script.

import StarlingBank from '@client-zone/starling'

From a modern browser.

import StarlingBank from '/node_modules/@client-zone/starling/dist/index.mjs'

© 2023-25 Lloyd Brookes <[email protected]>.

Documented by jsdoc-to-markdown.