HistoryModule
@liquidium/client / HistoryModule
Class: HistoryModule
Defined in: external/liquidium-sdk/packages/client/src/modules/history/history.ts:35
Historical pool, rate, user transaction, and liquidation data helpers.
Constructors
Constructor
new HistoryModule(
apiClient):HistoryModule
Defined in: external/liquidium-sdk/packages/client/src/modules/history/history.ts:36
Parameters
apiClient
ApiClient | undefined
Returns
HistoryModule
Methods
getBorrowRateHistory()
getBorrowRateHistory(
poolId,window?):Promise<PaginatedResponse<ApySample>>
Defined in: external/liquidium-sdk/packages/client/src/modules/history/history.ts:162
Returns borrow rate history for a pool.
Parameters
poolId
string
The pool principal text.
window?
Optional time window with from/to timestamps and limit.
Returns
Promise<PaginatedResponse<ApySample>>
Paginated APY samples.
getLiquidationHistory()
Call Signature
getLiquidationHistory(
user,filters?):Promise<PaginatedResponse<UserLiquidationHistoryEntry>>
Defined in: external/liquidium-sdk/packages/client/src/modules/history/history.ts:255
Returns liquidation history for a user.
Parameters
user
string
The Liquidium profile principal text.
filters?
Optional pool, time range, and pagination filters.
Returns
Promise<PaginatedResponse<UserLiquidationHistoryEntry>>
Paginated liquidation history entries.
Call Signature
getLiquidationHistory(
user,market?,filters?):Promise<PaginatedResponse<UserLiquidationHistoryEntry>>
Defined in: external/liquidium-sdk/packages/client/src/modules/history/history.ts:259
Returns liquidation history for a user.
Parameters
user
string
The Liquidium profile principal text.
market?
string
filters?
Optional pool, time range, and pagination filters.
Returns
Promise<PaginatedResponse<UserLiquidationHistoryEntry>>
Paginated liquidation history entries.
getPoolConfigHistory()
getPoolConfigHistory(
poolId,cursor?):Promise<PaginatedResponse<PoolConfigHistoryEntry>>
Defined in: external/liquidium-sdk/packages/client/src/modules/history/history.ts:87
Returns paginated configuration change history for a pool.
Parameters
poolId
string
The pool principal text.
cursor?
string
An optional pagination cursor from a previous response.
Returns
Promise<PaginatedResponse<PoolConfigHistoryEntry>>
A page of pool configuration changes and the next cursor when more results are available.
getPoolHistory()
getPoolHistory(
poolId,window?):Promise<PaginatedResponse<PoolHistoryEntry>>
Defined in: external/liquidium-sdk/packages/client/src/modules/history/history.ts:56
Returns paginated rate and utilization history for a pool.
Parameters
poolId
string
The pool principal text.
window?
Optional time window with from/to timestamps and limit.
Returns
Promise<PaginatedResponse<PoolHistoryEntry>>
A page of pool rate history entries and the next cursor when more results are available.
getUserTransactionHistory()
Call Signature
getUserTransactionHistory(
user,filters?):Promise<PaginatedResponse<UserTransactionHistoryEntry>>
Defined in: external/liquidium-sdk/packages/client/src/modules/history/history.ts:190
Returns transaction history for a user.
Parameters
user
string
The Liquidium profile principal text.
filters?
Optional pool, type, status, time range, and pagination filters.
Returns
Promise<PaginatedResponse<UserTransactionHistoryEntry>>
Paginated user history entries.
Call Signature
getUserTransactionHistory(
user,market?,filters?):Promise<PaginatedResponse<UserTransactionHistoryEntry>>
Defined in: external/liquidium-sdk/packages/client/src/modules/history/history.ts:194
Returns transaction history for a user.
Parameters
user
string
The Liquidium profile principal text.
market?
string
filters?
Optional pool, type, status, time range, and pagination filters.
Returns
Promise<PaginatedResponse<UserTransactionHistoryEntry>>
Paginated user history entries.