5-Minute Setup

Quickstart Guide

Start aggregating financial data in under 5 minutes. Free sandbox with simulated bank data — no credit card, no provider signup required.

1
2
3
4
1

Get Your API Key

Sign up for a free account to get instant access to your sandbox API key. No credit card required.

Sandbox API Key Format:

8pi_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
2

Install the SDK

Install the 8pimax SDK for your preferred language. We support Node.js, Python, and Go.

Node.js / TypeScript
npm install @8pimax/sdk
Python
pip install 8pimax
Go
go get github.com/8pimax/8pimax-go
3

Make Your First API Call

Initialize the client and create a sandbox connection to start testing immediately.

TypeScript
import { EightPimax } from '@8pimax/sdk';

const client = new EightPimax({
  apiKey: process.env.EIGHTPIMAX_API_KEY,
  environment: 'sandbox'
});

// Create a test connection using the universal sandbox
const link = await client.link.create({
  user_id: 'user_123',
  provider: 'sandbox', // Universal sandbox - works without provider credentials
  country: 'US'
});

console.log('Link token:', link.token);

Universal Sandbox

The sandbox provider works without any external credentials. Perfect for testing your integration before adding real provider keys.

4

Explore the Data

Once connected, you can fetch accounts, transactions, and balances using the unified API.

TypeScript
// Fetch accounts
const accounts = await client.accounts.list({
  connection_id: 'conn_xxx'
});

// Fetch transactions
const transactions = await client.transactions.list({
  connection_id: 'conn_xxx',
  start_date: '2024-01-01',
  end_date: '2024-12-31'
});

// Fetch current balances
const balances = await client.balances.get({
  connection_id: 'conn_xxx'
});

console.log(`Found ${accounts.data.length} accounts`);
console.log(`Found ${transactions.data.length} transactions`);

What's Next?

Need help? Check out the full documentation or contact support.