TypeScript SDK

npm install @logickoder/bankstract

import { bankstract } from '@logickoder/bankstract'
import { readFile } from 'node:fs/promises'

const client = bankstract({ apiKey: process.env.BANKSTRACT_API_KEY! })

const pdf = await readFile('statement.pdf')
const result = await client.parse(pdf)

console.log(result.metadata?.bank, result.transactions.length)

const { data, format, redactions } = await client.redact(pdf, { bank: 'gtbank' })
// `data` is the redacted document bytes (PDF or XLSX), in memory.
await writeFile(`redacted.${format}`, data)

const report = await client.inspect(pdf, { bank: 'fbn' })
// report.clean, report.signals: evidence about edits, never a verdict.
// signal.detail quotes the statement: never log it. Log code, severity, page and row.

const usage = await client.usage() // tier, parses this cycle, projected overage
const banks = await client.banks() // supported bank ids for the `bank` override

bankstract({
  apiKey, // required
  baseUrl, // default 'https://bankstract.logickoder.dev'
  fetch, // inject a fetch implementation; default globalThis.fetch
  timeoutMs, // per-request timeout, default 30000
})

import { RateLimitError, UnsupportedStatementError, BankstractError } from '@logickoder/bankstract'

try {
  await client.parse(pdf)
} catch (err) {
  if (err instanceof RateLimitError) {
    console.log('retry after', err.retryAfter, 'seconds')
  } else if (err instanceof UnsupportedStatementError) {
    console.log('no parser matched:', err.errorClass, err.markerCoverage)
  } else if (err instanceof BankstractError) {
    console.log(err.status, err.errorClass, err.message)
  }
}