GET
/
v0
/
aave
/
user_position_summary
/
get
from compassapisdk import CompassAPISDK, models


with CompassAPISDK(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api_sdk:

    res = compass_api_sdk.aave_v3.user_position_summary(chain=models.AaveUserPositionSummaryChain.ARBITRUM_MAINNET, user="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B")

    # Handle response
    print(res)
{
  "maximum_loan_to_value_ratio": "<string>",
  "health_factor": "<string>",
  "total_collateral": "<string>",
  "total_debt": "<string>",
  "available_borrows": "<string>",
  "liquidation_threshold": "<string>"
}

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

chain
enum<string>
default:arbitrum:mainnet
required

The chain to use.

Available options:
base:mainnet,
ethereum:mainnet,
arbitrum:mainnet
user
string
default:0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B
required

Response

200
application/json
Successful Response
maximum_loan_to_value_ratio
string
required

The loan to value ratio of a user.

health_factor
string
required

The health factor of a user. If this is above 1 it is safe; below 1 and the user is in risk of liquidation. This number might be very high (which would mean the user is safe!)

total_collateral
string
required

The total collateral (in USD) of a user.

total_debt
string
required

The total debt (in USD) of a user.

available_borrows
string
required

The available borrows (in USD) of a user.

liquidation_threshold
string
required

The liquidation threshold of a user. A user might exceed this due to changing asset values.