v4

latestOpenAPI 3.0.32026-08-07129194194.6 KB

Yield

Returns list of pools which correspond to the given params

get/v1/yield/pools

Query parameters

blockchainsApiSupportedBlockchain[]

If set, only pools from given blockchains will be returned

providersApiSupportedYields[]

If set, only pools from given pool providers 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

my_tokens_filter_addressstring

UQCNTO0Nh0Z7QNyRW1BLWfk08f2dAOw4izrx9sO6OUPg4DoV

If set, returns liquidity sources, where this user can supply it's tokens

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 liquidity providers, then handles and returns each group separately

sizeinteger

pageinteger

Response

List of corresponding pools

total_countinteger required

Example response

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