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:robinhood
required
Available options:
robinhood
owner
string
default:0x06A9aF046187895AcFc7258450B15397CAc67400
required

The wallet that owns the Risk Yield Account.

dex_version
enum<string> | null

Which Uniswap deployment a pool belongs to.

v3 pools hold their own tokens and pay LPs the fee tier. v4 pools live in a shared PoolManager and may route the fee through a hook, which is where the launchpad pools' zero LP yield comes from.

Available options:
V3,
V4
include_closed
boolean
default:false

Include positions with no liquidity and nothing owed. Off by default: a closed position is history, not a holding.

Response

Successful Response

account
string
required
positions
LpPosition · object[]
required
total_value_usd
string | null
total_unclaimed_fees_usd
string | null
total_pnl_usd
string | null
prices_updated_at
string<date-time> | null