Liquidium SDK documentation
Use @liquidium/client to build Liquidium integrations from TypeScript apps. Start with accountless Simple Loans unless your app needs a full profile dashboard.
Choose an integration path
Choose the path that matches your app:
| Path | Use when | Main SDK calls |
|---|---|---|
| Accountless Simple Loans | You want a short borrow flow where users do not create a Liquidium profile first | client.simpleLoans.create(...), client.simpleLoans.get(...), client.simpleLoans.find(...), client.activities.list(...) |
| Account-based profile flows | You want users to manage positions, supply funds, borrow, withdraw, or use ETH contract-interaction deposits | client.accounts.createProfile(...), client.lending.supply(...), client.lending.borrow(...), client.lending.withdraw(...), client.positions.listPositions(...) |
Documentation map
Use the following pages to find the information that you need:
| Section | Purpose |
|---|---|
| Getting started | Install the SDK and create your first Simple Loan flow |
| Guides | Complete specific integration tasks |
| Concepts | Understand protocol and SDK behavior before you design a flow |
| Status system | Read shared operation and state fields across loans, activities, and history |
| Examples | Run and inspect working apps |
| API reference | Look up exported SDK modules, types, and methods |
Environment requirements
The published package has the following runtime requirements:
| Requirement | Notes |
|---|---|
| Runtime APIs | Global fetch and BigInt support |
| Module format | ECMAScript module (ESM) or CommonJS support |
| Wallet provider | Provide a wallet integration. The examples use Dynamic. |
The @liquidium/client package does not declare a Node.js engine range. The
repository development tools have separate requirements:
| Requirement | Version |
|---|---|
| Node.js | 22.22.3 or later in the 22.x line, 24.x, or 26 or later |
| pnpm | 11 or later |