Skip to main content
GET
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

chain
enum<string>
default:base
required
Available options:
arbitrum,
base,
ethereum
block
integer | null

Optional block number (defaults to latest).

user
string
default:0x3254f3b1918637ba924e3F18968Cb74219974b63
required

The user to fetch the token-specific position of.

token
string
default:USDC
required

The symbol or address of the asset 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

token_balance
string
required

The balance of AAVE aTokens (interest-bearing representations of your deposits).

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
stable_debt
string
required

The amount of the user's debt with a fixed interest rate.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
variable_debt
string
required

The amount of the user's debt with a variable interest rate.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
principal_stable_debt
string
required

The amount of the user's debt that was part of the initial principal of all loans with a stable interest rate.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
principal_variable_debt
string
required

The amount of the user's debt that was part of the initial principal of all loans with a variable interest rate. This is the value stored by AAVE, which may be slightly inaccurate, but reflects what AAVE believes you initially paid.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
stable_borrow_rate
string
required

The current average annualised interest rate for all your stable loans in this pool.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
stable_borrow_rate_for_new_loans
string
required

The annualised interest rate you would pay on a new stable loan.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
variable_borrow_rate
string
required

The current annualised interest rate for variable rate loans in this pool. (This applies to both current and new loans.)

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
liquidity_rate
string
required

The annualised interest rate for deposited supplies.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$