API Reference
The SDK exports LiquidiumClient, error types, constants, module request types, response types, and wallet action types from @liquidium/client.
Client Modules
| Module | Purpose |
|---|---|
client.accounts | Profile lifecycle, account lookup, and linked wallets |
client.activities | Activity lists and receipt-oriented status |
client.history | Pool and user history through the Liquidium SDK API |
client.simpleLoans | Accountless Simple Loans with generated deposit and repayment targets |
client.lending | Supply, borrow, withdraw, and inflow reporting |
client.market | Pools, prices, and pool rate lookups |
client.positions | Per-pool positions, health, and aggregate stats |
client.quote | Pure quote helpers from market inputs |
Shared Status Types
Use LiquidiumStatus for flow state across Simple Loans, activities, lending responses, and history entries.
| Type | Purpose |
|---|---|
LiquidiumStatus | Operation, state, and optional confirmation progress |
LiquidiumOperation | deposit, borrow, repayment, withdrawal, or liquidation |
LiquidiumState | action_required, confirming, processing, active, completed, failed, or expired |
Activity | Inflow or outflow activity returned by activity APIs |
GetActivityStatusResponse | Found or missing result from client.activities.getStatus(...) |
See Status System for UI guidance.
Generated Reference
The generated API reference is built from the current @liquidium/client exports.
Regenerate it with TypeDoc and typedoc-plugin-markdown after changing exported APIs:
pnpm docs:api