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.

POST

aave

liquidity

change

get

curl --request POST \
  --url https://api.compasslabs.ai/v0/aave/liquidity/change/get \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "chain": "arbitrum:mainnet",
  "start_block": 0,
  "end_block": 319407231,
  "asset": "USDC"
}'

{
  "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.

Body

application/json

chain

enum<string>

required

The chain to use.

Available options:

base:mainnet,

ethereum:mainnet,

arbitrum:mainnet

start_block

integer

required

The starting block.

Example:

21500000

asset

enum<string>

required

The symbol of the asset to fetch liquidity index change for. Note the supported tokens per chain.

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

end_block

integer | null

The ending block. If nothing provided defaults to latest

Example:

21800000

Response

200

application/json

Successful Response

liquidity_change

string

required

The change in the liqudiity index between the two times, expressed as a percentage.

start_time

string

required

Dateime of starting block

end_time

string

required

Dateime of ending block

Was this page helpful?

Token prices Positions - total

curl --request POST \
  --url https://api.compasslabs.ai/v0/aave/liquidity/change/get \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "chain": "arbitrum:mainnet",
  "start_block": 0,
  "end_block": 319407231,
  "asset": "USDC"
}'

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

Endpoints

Authorizations

Body

Response