GET
/
v1
/
aave
/
rate
Typescript (SDK)
import { CompassApiSDK } from "@compass-labs/api-sdk";

const compassApiSDK = new CompassApiSDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await compassApiSDK.aaveV3.aaveRate({});

  console.log(result);
}

run();
{
  "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
enum<string>
default:USDC
required

The symbol of the asset to fetch the users' position on..

Available options:
1INCH,
AAVE,
AERO,
ARB,
BAL,
BNKR,
cbBTC,
cbETH,
CLANKER,
COPI,
CRV,
crvUSD,
CYBER,
DAI,
DOGINME,
eBTC,
ENS,
ETH,
ETHFI,
ETHx,
EURC,
EUR,
EURS,
eUSDe,
ezETH,
FBTC,
FRAX,
FXS,
GHO,
KNC,
LBTC,
LDO,
LINK,
LsETH,
LUSD,
MAI,
MKR,
osETH,
PT-eUSDE-14AUG2025,
PT-eUSDE-29MAY2025,
PT-sUSDE-25SEP2025,
PT-sUSDE-31JUL2025,
PT-USDe-31JUL2025,
PYUSD,
rETH,
RLUSD,
RPL,
rsETH,
sDAI,
SNX,
STG,
sUSDe,
tBTC,
UNI,
USDbC,
USDCe,
USDC,
USDe,
USDS,
USDtb,
USDT,
VIRTUAL,
WBTC,
weETH,
WELL,
WETH,
wrsETH,
wstETH

Response

200
application/json

Successful Response

The response is of type object.