Skip to main content
GET
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Path Parameters

pool_id
integer
required

The pool id, as returned by GET /pools.

Query Parameters

chain
enum<string>
default:robinhood
required
Available options:
robinhood
depth_words
integer
default:4

How many 256-tick words either side of the current price to read for the liquidity distribution. More is a wider picture and more node calls.

Required range: 1 <= x <= 16
history
enum<string>
default:7d
Available options:
24h,
7d,
30d

Response

Successful Response

pool
DexPoolInfo · object
required
on_chain
PoolOnChainState · object | null

Read live, at request time.

The indexer's numbers are minutes old, which is fine for ranking and not fine for sizing a position on an asset that moves this fast.

liquidity_distribution
LiquidityBucket · object[]
hourly
PoolHourlyPoint · object[]
stock_reference
StockReference · object | null

The pool price against the stock's own reference price.

A tokenized stock trades in its pool around the clock while the underlying trades in a session. The gap between them is real information — it is what an LP is quoting against overnight — and it is not visible from either number alone.

warnings
string[]

Things worth knowing before providing liquidity here.