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

    # Handle response
    print(res)
{
  "supply_apy_variable_rate": "<string>",
  "supply_apr_variable_rate": "<string>",
  "borrow_apy_variable_rate": "<string>",
  "borrow_apr_variable_rate": "<string>",
  "borrow_apy_fixed_rate": "<string>",
  "borrow_apr_fixed_rate": "<string>"
}

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 token to fetch the user's position on.. A token identifier - either a supported symbol (e.g., USDC, WETH) or a valid Ethereum address (0x...)

Examples:

"USDC"

"WETH"

"0xA0b86a33E6441ccF30EE5DdEF1E9b652C91ac1c8"

Response

Successful Response

​
supply_apy_variable_rate
string
required

Variable rate APY for deposits.

​
supply_apr_variable_rate
string
required

Variable rate APR for deposits.

​
borrow_apy_variable_rate
string
required

Variable rate APY for loans.

​
borrow_apr_variable_rate
string
required

Variable rate APR for loans.

​
borrow_apy_fixed_rate
string
required

Fixed rate APY for loans.

​
borrow_apr_fixed_rate
string
required

Fixed rate APR for loans.