This API retrieves the balances of a given address within supported lending protocols.
Potential Use-Cases
You can visualize an EOA's latest and historic positions.
Sample Visualization
The responses from this endpoint can be visualized like this
Response Data
The table below will help you understand the contents of payload.data in the API response.
Field | Type | Description |
|---|---|---|
timestamp |
| The instant in time when this portfolio snapshot was taken. |
totalLiquidityETH |
| The total amount deposited into the protocol by the wallet/address as measured in ETH. This value will always be |
totalLiquidityUSD |
| The total amount deposited into the protocol by the wallet/address as measured in USD. This value will always be |
totalCollateralETH |
| The total amount of collateral that this wallet/address has supplied to the protocol as measured in ETH. |
totalCollateralUSD |
| The total amount of collateral that this wallet/address has supplied to the protocol as measured in USD. |
totalBorrowedETH |
| The total amount borrowed by this wallet/address as measured in ETH. |
totalBorrowedUSD |
| The total amount borrowed by this wallet/address as measured in USD. |
availableToBorrowETH |
| The total amount that can still be borrowed by this wallet/address as measured in ETH. |
availableToBorrowUSD |
| The total amount that can still be borrowed by this wallet/address as measured in USD. |
netWorthETH |
| The difference between totalCollateralETH and totalBorrowedETH. |
netWorthUSD |
| The difference between totalCollateralUSD and totalBorrowedUSD. |
lifetimeRewardsETH |
| Total amount of protocol incentives generated by this address for participating in the protocol, as measured in ETH. |
lifetimeRewardsUSD |
| Total amount of protocol incentives generated by this address for participating in the protocol, as measured in USD. |
unclaimedRewardsETH |
| Total amount of protocol incentives that have not yet been claimed by this address as measured in ETH. |
unclaimedRewardsUSD |
| Total amount of protocol incentives that have not yet been claimed by this address as measured in USD. |
healthFactor |
| A risk metric that indicates how close this wallet/address is to being liquidated within the protocol. A value
|
loanToValueRatio |
| The maximum loan value for this wallet/address. Ranges from 0 to 1. |
liquidationThresholdRatio |
| The limit at which this wallet/address is considered undercollateralized. Ranges from 0 to 1. |
positions |
| The collection of all lending and borrowing positions that this address holds, broken down by asset. |
positions[index].assetId |
| The smart contract address for the asset. |
positions[index].assetSymbol |
| The human readable asset symbol. |
positions[index].positionType |
| Indicates whether this asset is being lent or borrowed. |
positions[index].isCollateral |
| Indicates whether this asset is being used as collateral or not. |
positions[index].loanToValueRatio |
| The maximum loan value for this asset. |
positions[index].liquidationThresholdRatio |
| Defines the limit at which a position is considered undercollateralized. |
positions[index].amountNative |
| The amount of this asset in this position, normalized with its decimals. |
positions[index].amountUSD |
| The amount of this asset in this position as measured in USD. |
positions[index].interestRateAPY |
| Multiply this value by 100 to get interest rate as a percentage. Example: Should be interpreted as |
positions[index].interestRateType |
| Denotes the interest rate type, either |
positions[index].market |
| Indicates what market the asset positions belongs to.
|
positions[index].duration |
| The number of days the position has been open. |
totalLiquidity* in Compound v3
Only the market (base) asset will be considered as liquidity. All other deposited assets are considered collateral. So it is possible for an EOA to have zero liquidity and non-zero collateral.
A common scenario where this happens is when an EOA only has
Borrowpositions of a market asset and has never deposited any of the market asset.