v1

latestOpenAPI 3.0.32026-07-263871106.2 KB
Pools

Pools

Returns a paginated list of pools

get/pools

Query parameters

{"stackTrail":"paths:/pools:get:parameters:0:schema","oasType":"schema","type":"unknown"}

Page number (1-based)

{"stackTrail":"paths:/pools:get:parameters:1:schema","oasType":"schema","type":"unknown"}

Number of pools to return per page. Max 1000

{"stackTrail":"paths:/pools:get:parameters:2:schema","oasType":"schema","type":"unknown"}

Search query used to match pools by name, tokens, or address

{"stackTrail":"paths:/pools:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Sort results by one or more fields

Format:

  • Time-windowed metrics: <metric>_<window>:<direction>

  • Non-windowed metrics: <field>:<direction>

  • direction: asc or desc

  • window (when applicable): 5m 30m 1h 2h 4h 12h 24h

Available fields:

  • Time-windowed metrics: volume_* fee_* fee_tvl_ratio_* apr_*
  • Non-windowed metrics: tvl fee_pct bin_step pool_created_at farm_apy

Default: volume_24h:desc

Examples:

  • volume_24h:desc
  • fee_1h:asc
  • tvl:desc
{"stackTrail":"paths:/pools:get:parameters:4:schema","oasType":"schema","type":"unknown"}

Conditions to filter documents by field values

Format: <expr> [&& <expr> ...]

Where each expression is: <field><op><value>

Allowed fields:

  • Numeric: tvl volume_* fee_* fee_tvl_ratio_* apr_*
  • Boolean: is_blacklisted
  • Text: pool_address name token_x token_y

Operators:

  • Numeric: = > >= < <=
  • Boolean: =true =false
  • Text:
    • exact match: =<value>
    • multi-value OR: =[value1|value2|...]

Notes:

  • Multiple expressions are combined using logical AND (&&)
  • Whitespace around operators is ignored

Examples:

  • tvl>1000
  • is_blacklisted=false && volume_24h>=50000

Response

current_pageinteger required
page_sizeinteger required
pagesinteger required
totalinteger required