GET
/
v1
/
yield
/
pools
Returns list of pools which correspond to the given params
curl --request GET \
  --url https://backend.swap.coffee/v1/yield/pools
[
  {
    "total_count": 123,
    "pools": [
      {
        "address": "<string>",
        "protocol": "stonfi",
        "is_trusted": true,
        "tokens": [
          {
            "address": {
              "blockchain": "ton",
              "address": "native"
            },
            "metadata": {
              "name": "ARBUZ",
              "symbol": "ARBUZ",
              "decimals": 123,
              "image_url": "<string>",
              "listed": true,
              "verification": "whitelisted"
            }
          }
        ],
        "pool_statistics": {
          "address": "<string>",
          "tvl_usd": 123,
          "volume_usd": 123,
          "fee_usd": 123,
          "apr": 123,
          "lp_apr": 123,
          "boost_apr": 123,
          "locked_asset_amount": "<string>"
        },
        "pool": {
          "amm_type": "constant_product"
        }
      }
    ]
  }
]

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
blockchains
enum<string>[]

If set, only pools from given blockchains will be returned

​
providers
enum<string>[]

If set, only pools from given pool providers will be returned

​
trusted
boolean
default:true

Returns only those pools which are trusted by DEXes or community

​
with_active_boosts
boolean
default:false

Returns only pools which have active boosts

​
recently_created
boolean
default:false

Returns only pools created within last 24 hours

​
with_liquidity_from
string

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

​
my_tokens_filter_address
string

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

​
search_text
string

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

​
order
enum<string>
Available options:
tvl,
volume,
apr
​
descending_order
boolean
default:true
​
in_groups
boolean
default:false

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

​
size
integer
default:10
Required range: 1 <= x <= 100
​
page
integer
default:1
Required range: x >= 1

Response

200
application/json

List of corresponding pools

The response is of type object[].