How do I list and read pools?
Use GET /api/v1/pools for a list. It returns { items, total, limit, offset }.
| Query | Rule |
|---|---|
symbol | Optional ticker, up to 16 valid ticker chars |
kind | canonical, meme, or stock-stock |
q | Text search, up to 80 chars |
limit | 1 to 50; default 25 |
offset | Non-negative integer; default 0 |
curl 'https://api.squeeze.plus/api/v1/pools?symbol=NVDA&kind=meme&limit=25&offset=0'Use GET /api/v1/pools/:id?range=24h for one pool. Its reply has pool, at most 600 series rows, and at most 100 swaps. The range choices match stock detail.
offset can be at most 1,000,000. A pool ID must start with 0x and hold 40 or 64 hex chars.
| Field group | Fields |
|---|---|
| ID | id, version, kind, createdBlock |
| Tokens | token0, token1, stockSymbol, stockIsToken0, otherSymbol, otherAddress, stockAddress |
| Pool set-up | fee, tickSpacing, hooks |
| Read state | active, hot, lastSwapTs, lastSwapBlock, stateTs, enrichedTs |
| Raw state | sqrtPriceX96, liquidity |
| Amounts | stockReserve, otherReserve, reserveSource |
| Prices | stockPriceInOther, stockPriceUsd, otherPriceUsd |
| Value and volume | liquidityUsd, vol1hUsd, vol24hUsd |
| Trust | comparable, dataStatus |
Amounts, prices, value, volume, state times, and hook data can be null. stockIsToken0, active, hot, and comparable are booleans.
Sample
Section titled “Sample”A v3 id is a pool address. A v4 id is a pool ID. Keep the full ID when you ask for detail.