POST
/
v0
/
aave
/
user_position_summary
/
get
curl --request POST \
  --url https://api.compasslabs.ai/v0/aave/user_position_summary/get \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "chain": "arbitrum:mainnet",
  "user": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
}'
{
  "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.

Body

application/json
​
chain
enum<string>
required

The chain to use.

Available options:
base:mainnet,
ethereum:mainnet,
arbitrum:mainnet
​
user
string
required

The user to get the position summary of. Values are in USD.

Example:

"0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45"

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.

Was this page helpful?