v4

latestOpenAPI 3.0.32026-08-07129194194.6 KB

Entity

Returns list of pools which correspond to the given params

get/v1/pools

Query parameters

blockchainsApiSupportedBlockchain[]

If set, only pools from given blockchains will be returned

dexesApiSupportedYields[]

If set, only pools from given DEXes will be returned

trustedboolean

Returns only those pools which are trusted by DEXes or community

with_active_boostsboolean

Returns only pools which have active boosts

recently_createdboolean

Returns only pools created within last 24 hours

with_liquidity_fromstring

If set, returns only pools in which liquidity has been partially provisioned by the given address

search_textstring

If set, look for given (sub-)text within pool's address, token tickers and addresses

order'tvl' | 'volume' | 'apr'

descending_orderboolean

in_groupsboolean

If set, groups pools by DEXes, then handles and returns each group separately

sizeinteger

pageinteger

Response

List of corresponding pools

total_countinteger required

Example response

[
  {
    "pools": [
      {
        "pool": {
          "dex": "stonfi",
          "tokens": [
            {
              "address": {
                "blockchain": "ton",
                "address": "native"
              },
              "metadata": {
                "name": "ARBUZ",
                "symbol": "ARBUZ"
              }
            }
          ]
        }
      }
    ]
  }
]