GET
/
v1
/
pools
curl --request GET \
  --url https://backend.swap.coffee/v1/pools
[
  {
    "total_count": 123,
    "pools": [
      {
        "pool": {
          "dex": "stonfi",
          "address": "<string>",
          "type": "public",
          "amm_type": "constant_product",
          "amm_settings": {},
          "tokens": [
            {
              "address": {
                "blockchain": "ton",
                "address": "native"
              },
              "metadata": {
                "name": "ARBUZ",
                "symbol": "ARBUZ",
                "decimals": 123,
                "image_url": "<string>",
                "listed": true
              }
            }
          ],
          "reserves": [
            123
          ],
          "restrictions": [
            {
              "min_swap_amount": 123,
              "max_swap_amount": 123
            }
          ],
          "fees": {
            "average_gas": 123,
            "divider": 123,
            "input": 123,
            "output": 123,
            "first_token": 123,
            "second_token": 123
          },
          "unavailable_until": 123
        },
        "info": {
          "address": "<string>",
          "tvl_usd": 123,
          "volume_usd": 123,
          "fee_usd": 123,
          "apr": 123,
          "lp_apr": 123,
          "boost_apr": 123
        }
      }
    ]
  }
]

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
blockchains
enum<string>[]

If set, only pools from given blockchains will be returned

Available options:
ton
​
dexes
enum<string>[]

If set, only pools from given DEXes will be returned

Available options:
stonfi,
dedust,
stonfi_v2,
coffee,
tonco,
tonstakers
​
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

​
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 DEXes, 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
​
total_count
integer
required
​
pools
object[]
required