[
/docs
·
api v3.2
]
Docs written by the people on call.
Guides and reference for the Sluice API, from the first session to the day a bank changes its login. Every page lists the version it was tested on.
[ introduction ]
One REST API, three jobs.
Ask a user for permission, read the accounts they shared, and keep them fresh until the consent ends. Requests and responses are JSON, every write accepts an Idempotency-Key, and the version is pinned per key.
Base URL
https://api.sluice.dev/v3
Sandbox keys start with sk_test_ and only reach test banks. Live keys start with sk_live_.
Authentication
Send your secret key as a bearer token on every request. Keys live on your server only; the consent flow runs on a short-lived session link instead.
curl https://api.sluice.dev/v3/accounts \
-H ‘Authorization: Bearer sk_test_••••4f2’
Guides
Errors
Errors return a status code and a JSON body with a stable code you can switch on. The message is for humans and may change.
400
A parameter is missing or malformed.
401
The key is missing, revoked or for another mode.
403
The user or the bank ended this consent.
404
No object with that id in this project.
409
Same key, different request body.
429
Slow down; retry after the Retry-After header.
Rate limits
100 requests per second per key in live mode, 25 in sandbox. Every response carries X-RateLimit-Remaining; a 429 tells you when to try again.
Node
Python
cURL
connect
import { Sluice } from ‘@sluice/node’;
const sluice = new Sluice(process.env.SLUICE_KEY);
const session = await sluice.connect.sessions.create({
user: ‘user_31c’,
scopes: [‘balances’, ‘transactions’],
});
// send session.url to your user
201 Created · 84 ms
id cs_7Hq2
url https://connect.sluice.dev/cs_7Hq2
expires_in 900
[
02
·
status
]
All systems, right now.
Demo data. Point this block at your own status page when you go live.
Connect sessions
99.98% · 90 d
Accounts API
99.99% · 90 d
Transactions sync
99.95% · 90 d
Webhooks
99.97% · 90 d
Dashboard
100% · 90 d
status checked
1 s ago
[
03
·
changelog
]
Shipped lately.
Sluice® Template
$129 · one-time
NOVA STUDIO
/ SECURED BY POLAR