Python (SDK)

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.aave_v3.aave_liquidity_change(chain=models.V1AaveLiquidityChangeChain.ARBITRUM, token="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

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

Python (SDK)

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.aave_v3.aave_liquidity_change(chain=models.V1AaveLiquidityChangeChain.ARBITRUM, token="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

required

Available options:

arbitrum,

base,

ethereum

token

string

default:USDC

required

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

Examples:

"USDC"

"WETH"

"0xA0b86a33E6441ccF30EE5DdEF1E9b652C91ac1c8"

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

Successful Response

liquidity_change

string

required

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

start_time

string<date-time>

required

Dateime of starting block

end_time

string<date-time>

required

Datetime of ending block

Token Prices Positions - Total

API Reference

Authorizations

Query Parameters

Response