Aave V3

Liquidity index

This endpoint retrieves the change in the reserve liquidity index between two provided blocks.

This is then converted to a percentage change. The liquidity index represents the change in debt and interest accrual over each block. Aave does not store individual user balances directly. Instead, it keeps a scaled balance and uses the liquidity index to compute real balances dynamically. If a user was to have deposited tokens at the start block, a positive liquidity index change will represent accrued interest and a profit. If tokens were borrowed at the start block, this debt will increase, compound on itself and represent large debt. The reverse in both cases is true if the liquidity index is negative.

GET

aave

liquidity

change

get

from compassapisdk import CompassAPISDK, models


with CompassAPISDK(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api_sdk:

    res = compass_api_sdk.aave_v3.liquidity_change(chain=models.AaveLiquidityChangeChain.ARBITRUM_MAINNET, token=models.AaveLiquidityChangeToken.USDC, start_block=0, end_block=319407231)

    # Handle response
    print(res)

{
  "liquidity_change": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key

string

header

required

Your Compass API Key. Get your key here.

Query Parameters

chain

enum<string>

default:arbitrum:mainnet

required

The chain to use.

Available options:

base:mainnet,

ethereum:mainnet,

arbitrum:mainnet

token

enum<string>

default:USDC

required

The symbol of the asset to get liquidity change for..

Available options:

1INCH,

AAVE,

BAL,

cbBTC,

cbETH,

CRV,

crvUSD,

DAI,

ENS,

ETHx,

FRAX,

FXS,

GHO,

KNC,

LDO,

LINK,

LUSD,

MKR,

osETH,

PYUSD,

rETH,

RPL,

rsETH,

sDAI,

SNX,

STG,

sUSDe,

tBTC,

UNI,

USDC,

USDe,

USDS,

USDT,

WBTC,

weETH,

WETH,

wstETH,

ARB,

EURS,

MAI,

USDCe,

AERO,

EUR,

VIRTUAL

start_block

integer

default:0

required

The start block to calculate liquidity change from.

Required range: x >= 0

end_block

integer

default:319407231

required

The end block to calculate liquidity change to.

Required range: x >= 0

Response

200

application/json

Successful Response

The response is of type object.

Token prices Positions - total

from compassapisdk import CompassAPISDK, models


with CompassAPISDK(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api_sdk:

    res = compass_api_sdk.aave_v3.liquidity_change(chain=models.AaveLiquidityChangeChain.ARBITRUM_MAINNET, token=models.AaveLiquidityChangeToken.USDC, start_block=0, end_block=319407231)

    # Handle response
    print(res)

{
  "liquidity_change": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z"
}

Aave V3

Aerodrome Slipstream

Morpho

Sky

Token

Uniswap V3

Universal

Transaction Batching

Liquidity index

Authorizations

Query Parameters

Response