sloe/ developers

Make your first API call

Read one institution with a Data Access key, then inspect the result.

1. Get the right access

Sign in to your Sloe account with the purchase email, complete any password setup and choose Generate Key. Copy the full key when shown and store it securely; it is shown only once. You need a licensed Data Access API key for these calls. An Individual or Organization subscription can connect through MCP browser sign-in; that does not automatically grant direct API or bulk rights. Compare access paths.

Keep your key in your server's secret store or a local environment variable. In these examples, SLOE_API_KEY is an environment variable you choose; it is not a required Sloe SDK setting.

export SLOE_API_KEY='YOUR_DATA_ACCESS_KEY'

Use a placeholder while sharing examples. Never paste a working key into a chat, repository or URL.

2. Request an institution

Charter numbers identify credit unions. This example looks up charter 1367; it does not assume a particular financial value or reporting quarter.

curl --fail-with-body --silent --show-error \
  'https://sloedata.com/api/cuwiredata-institution?charter=1367' \
  -H "Authorization: Bearer $SLOE_API_KEY"

A successful JSON response has ok: true and a data object. For the default financial view, look at data.institution, data.balances, data.ratios and data.release. Keep trace_id for troubleshooting.

3. Read it in JavaScript

Run this on your server using a modern Node.js runtime with fetch:

const url = new URL('/api/cuwiredata-institution', 'https://sloedata.com');
url.searchParams.set('charter', '1367');
const key = process.env.SLOE_API_KEY;
if (!key) throw new Error('Set SLOE_API_KEY');

const response = await fetch(url, {
  headers: { Authorization: `Bearer ${key}` },
  signal: AbortSignal.timeout(30_000),
});
const result = await response.json();
if (!response.ok || result.ok !== true) {
  throw new Error(
    `Sloe request failed (${response.status}); trace=${result.trace_id ?? 'unavailable'}`
  );
}
console.log(result.data.institution);
console.log(result.data.balances);

4. Or use Python

This example uses only Python's standard library. HTTP errors raise an exception; do not treat them as empty results.

import json
import os
from urllib.request import Request, urlopen

request = Request(
    'https://sloedata.com/api/cuwiredata-institution?charter=1367',
    headers={'Authorization': f"Bearer {os.environ['SLOE_API_KEY']}"},
)
with urlopen(request, timeout=30) as response:
    result = json.load(response)
if result.get('ok') is not True:
    raise RuntimeError(f"Sloe error; trace={result.get('trace_id')}")
print(result['data']['institution'])

Next steps

Download and verify your first Parquet file, or read service and support.

Search institutions, build a server-side integration, or keep a paginated import consistent. Check the actual reporting period before displaying a value as current.

On this page