Liquidium SDK Docs
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
| 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(...) |
Docs Map
| 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 designing 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 |
Runtime Requirements
| Requirement | Notes |
|---|---|
| Node.js | 20+ for local SDK development |
| Package manager | pnpm 11+ for this repository |
| Browser APIs | fetch, BigInt, and standard ESM support |
| Wallet UI | Bring your own wallet provider. The examples use Dynamic. |