[
/docs
·
Get started
]
Quickstart
Create a connect session, open Connect and read your first accounts.
group
Get started
Install the SDK with npm i @sluice/node or pip install sluice, and set SLUICE_SECRET_KEY to the test key from your dashboard. Test keys start with sk_test_ and only reach the sandbox.
On your server, call POST /v3/connect/sessions with the scopes you need, for example balances and transactions. The response includes a session id that expires after 30 minutes.
Pass the session id to Connect in your front end. When the user approves, Connect returns a connection id and Sluice sends connection.created to your webhook endpoint.
Call GET /v3/accounts?connection_id=… to list the accounts. You now have a live connection; the rest of the docs cover keeping it fresh.
[ example request ]
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
[
→
·
more guides
]
Next on the list.
Sluice® Template
$129 · one-time
NOVA STUDIO
/ SECURED BY POLAR