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 get position summary for.

Response

Successful Response

maximum_loan_to_value_ratio
string
required

The loan to value ratio of a user.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
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!)

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

The total collateral (in USD) of a user.

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

The total debt (in USD) of a user.

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

The available borrows (in USD) of a user.

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

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

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