Track Positions - Lending Wallets

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.

FieldTypeDescription
timestampnumberThe instant in time when this portfolio snapshot was taken.
totalLiquidityETHnumberThe total amount deposited into the protocol by the wallet/address as measured in ETH.

This value will always be >= totalCollateralETH since not all deposited assets need to be used as collateral.
totalLiquidityUSDnumberThe total amount deposited into the protocol by the wallet/address as measured in USD.

This value will always be >= totalCollateralUSD since not all deposited assets need to be used as collateral.
totalCollateralETHnumberThe total amount of collateral that this wallet/address has supplied to the protocol as measured in ETH.
totalCollateralUSDnumberThe total amount of collateral that this wallet/address has supplied to the protocol as measured in USD.
totalBorrowedETHnumberThe total amount borrowed by this wallet/address as measured in ETH.
totalBorrowedUSDnumberThe total amount borrowed by this wallet/address as measured in USD.
availableToBorrowETHnumberThe total amount that can still be borrowed by this wallet/address as measured in ETH.
availableToBorrowUSDnumberThe total amount that can still be borrowed by this wallet/address as measured in USD.
netWorthETHnumberThe difference between totalCollateralETH and totalBorrowedETH.
netWorthUSDnumberThe difference between totalCollateralUSD and totalBorrowedUSD.
lifetimeRewardsETHnumberTotal amount of protocol incentives generated by this address for participating in the protocol, as measured in ETH.
lifetimeRewardsUSDnumberTotal amount of protocol incentives generated by this address for participating in the protocol, as measured in USD.
unclaimedRewardsETHnumberTotal amount of protocol incentives that have not yet been claimed by this address as measured in ETH.
unclaimedRewardsUSDnumberTotal amount of protocol incentives that have not yet been claimed by this address as measured in USD.
healthFactornumberA risk metric that indicates how close this wallet/address is to being liquidated within the protocol.

A value <= 1 indicates that the wallet/address will be liquidated.

Note: This metric is unique to Aave.
loanToValueRationumberThe maximum loan value for this wallet/address. Ranges from 0 to 1.
liquidationThresholdRationumberThe limit at which this wallet/address is considered undercollateralized. Ranges from 0 to 1.
positionsarrayThe collection of all lending and borrowing positions that this address holds, broken down by asset.
positions[index].assetIdstringThe smart contract address for the asset.
positions[index].assetSymbolstringThe human readable asset symbol.
positions[index].positionTypestring (Lend | Borrow)Indicates whether this asset is being lent or borrowed.
positions[index].isCollateralbooleanIndicates whether this asset is being used as collateral or not.
positions[index].loanToValueRationumberThe maximum loan value for this asset.
positions[index].liquidationThresholdRationumberDefines the limit at which a position is considered undercollateralized.
positions[index].amountNativenumberThe amount of this asset in this position, normalized with its decimals.
positions[index].amountUSDnumberThe amount of this asset in this position as measured in USD.
positions[index].interestRateAPYnumberMultiply this value by 100 to get interest rate as a percentage.

Example: "interestRateAPY": 0.038774376844581834

Should be interpreted as 3.877%.
positions[index].interestRateTypestring (Variable | Stable)Denotes the interest rate type, either Variable or Stable.
positions[index].marketstringIndicates what market the asset positions belongs to.

Note: This is unique to MakerDAO.
positions[index].durationnumberThe 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 Borrow positions of a market asset and has never deposited any of the market asset.

Path Params
string
required
Defaults to aavev3
string
required
Defaults to 0x884d6fa3a4b349880486ad4d7c833ca968c785d8

The address for which the portfolio summary is desired. Example address is for aavev3 plus polygon-mainnet only.

Query Params
string
Defaults to hr

[Optional] Time format of the timestamps in the return payload.

string

[Optional] If provided, returns the balances of the address at this date. Enables historical look-back of the portfolio.
[Formats] seconds | milliseconds | iso8601
[Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00
[Warning] Cannot be combined with blockNumber, use only one, either endDate or blockNumber.

int32

[Optional] If provided, returns the balances of the address when this block was finalized. Enables historical look-back of the portfolio.
[Warning] Cannot be combined with endDate, use only one, either blockNumber or endDate.

Headers
string
required
Defaults to polygon-mainnet

[Optional] The id of the blockchain for which you want protocol data from. Defaults to ethereum-mainnet if not specified. Use the Information Protocols API to view the supported protocol and blockchain id combinations.

Response

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json