latestOpenAPI 3.0.02026-08-10111234.7 KB

742e86bc3ab0

pools

Returns pool data for all listed pools, optionally filterable by the pool's comptroller address.

Versioning (controlled via accept-version header):

  • stable (default): chainId is required. Returns a paginated list of pools with embedded markets (filtered to isListed: true) and a top-level tokens array of TokenMetadata.
  • next: chainId is optional; accepts a JSON array string for multi-chain queries (e.g. ["56","1"]). Returns pools grouped by chainId alongside a separately paginated markets list with underlyingTokenMetadata embedded in each market. No top-level tokens field.
get/pools

Query parameters

addressstring

[both] Filter by pool comptroller address.

namestring

[both] Filter by pool name.

priceOracleAddressstring

[both] Filter by price oracle address.

chainIdstring

[stable] Required. [next] Optional; accepts a JSON array string for multi-chain queries (e.g. ["56","1"]).

orderstring

[both] Columns to sort by. Default is descending. Prepend + for ascending (e.g. +name).

limitinteger

[both] Maximum number of results to return.

pageinteger

[both] Page number for pagination.

Headers

accept-version'stable' | 'next'

Selects the API version. stable (default) requires chainId and returns a paginated list with embedded markets and a top-level tokens array. next supports multi-chain queries and returns pools grouped by chainId with markets in a separate paginated block.

Response

Returns Pool data for all listed pools.

OR