Skip to main content
GET
/
v1
/
aave
/
reserve_overview
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_reserve_overview(chain=models.V1AaveReserveOverviewChain.ARBITRUM, token="USDC")

    # Handle response
    print(res)
{
  "tvl": 1,
  "total_borrowed": 1,
  "utilization_ratio": 0.5
}

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
​
block
integer | null

Optional block number (defaults to latest).

​
token
string
default:USDC
required

The symbol or address of the asset.. A token identifier - either a supported symbol (e.g., USDC, WETH) or a valid Ethereum address (0x...)

Examples:

"USDC"

"WETH"

"0xA0b86a33E6441ccF30EE5DdEF1E9b652C91ac1c8"

Response

Successful Response

​
tvl
number
required

Total tokens supplied in an Aave Reserve in USD. E.G. How much WBTC has been supplied on Aave in USD.

Required range: x >= 0
​
total_borrowed
number
required

Total tokens borrowed in an Aave Reserve converted to USD. E.G. How much WBTC has been supplied on Aave (in USD).

Required range: x >= 0
​
utilization_ratio
number | null
required

Total borrowed divided by total supplied in an Aave Reserve. E.G. How much WBTC has been borrowed on Aaave divided by the amount supplied

Required range: 0 <= x <= 1