Skip to main content
GET
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Query Parameters

offset
integer
default:0

The offset of the first item to return.

limit
integer
default:20

The number of items to return.

Required range: x <= 1000
chain
enum<string>
default:robinhood
required
Available options:
robinhood
pair_class
enum<string> | null
default:MEME_STOCK

What kind of pair a pool is, which is what the product is sorted by.

Available options:
MEME_STOCK,
STOCK_STABLE,
STOCK_ETH,
STOCK_STOCK,
MEME_ETH,
MEME_STABLE,
ETH_STABLE,
OTHER
token
string | null

Pools holding this token, on either side.

stock_ticker
string | null
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
launchpad
enum<string> | null
Available options:
PONS_V1,
PONS_V2,
POOLS_TRADE,
BAGS
lp_earns_fees
boolean | null
default:true

Leave unset to see everything. Set true to hide the pools whose hook keeps the fee — most of this chain's volume, and none of its yield.

lp_open
boolean | null
default:true

Whether liquidity may be added at all.

watched
boolean | null

Only pools the indexer follows closely, which are the only ones with trailing metrics.

min_tvl_usd
Required range: x >= 0
min_volume_24h_usd
Required range: x >= 0
order_by
enum<string>
default:il_adjusted_apr_7d
Available options:
il_adjusted_apr_7d,
fee_apr_24h,
fee_apr_7d,
tvl_usd,
volume_24h_usd,
volume_7d_usd,
realized_vol_24h,
realized_vol_7d,
created_at
direction
enum<string>
Available options:
asc,
desc

Response

Successful Response

total
integer
required
offset
integer
required
limit
integer
required
pools
DexPoolInfo · object[]
required