REST API

Read pools, tokens, swaps, and positions as JSON.

Base URL: https://hyperpools.dev/api/v1.

APP=https://hyperpools.dev
curl -fsS "$APP/api/v1/openapi.json"

Endpoints

All paths below are relative to /api/v1.

PathQuery contract
/statusno query parameters; current public status
/deploymentsno query parameters; accepted deployment inventory
/disclosureno query parameters; versioned public disclosure
/incidentsno query parameters; latest 100 incidents
/poolsversion, limit, cursor; exact lookup also needs poolId
/tokenslimit+cursor, or paired indexedBlock and indexedBlockHash
/swapsversion, pool, limit, cursor
/positionsrequired owner; optional version, pool, limit, cursor
/positions/v2/{pairAddress}required owner
/positions/v3/{tokenId}optional exact owner check
/positions/v4/{tokenId}optional exact owner check
/hook-sharesrequired owner; optional poolId, limit, cursor
/hook-shares/{poolId}/{owner}no query parameters
/reports/proposaldays=30 or days=90
/openapi.jsonno query parameters

Request and response behavior

Successful bodies use { "data": ..., "meta": ... }. Paginated bodies may include nextCursor.

Limits

The API does not support historical block arguments, subscriptions, batching, USD prices, TVL, fee accounting, candles, position valuation, or beneficial ownership.

On this page