Returns list of pools which correspond to the given params
curl --request GET \
--url https://backend.swap.coffee/v1/pools \
--header 'X-Api-Key: <api-key>'import requests
url = "https://backend.swap.coffee/v1/pools"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://backend.swap.coffee/v1/pools', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://backend.swap.coffee/v1/pools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://backend.swap.coffee/v1/pools"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://backend.swap.coffee/v1/pools")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.swap.coffee/v1/pools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"total_count": 123,
"pools": [
{
"pool": {
"dex": "stonfi",
"address": "<string>",
"type": "public",
"amm_type": "constant_product",
"tokens": [
{
"address": {
"blockchain": "ton",
"address": "native"
},
"metadata": {
"name": "ARBUZ",
"symbol": "ARBUZ",
"decimals": 123,
"listed": true,
"verification": "whitelisted",
"image_url": "<string>"
}
}
],
"reserves": [
123
],
"fees": {
"average_gas": 123,
"divider": 123,
"input": 123,
"output": 123,
"first_token": 123,
"second_token": 123
},
"amm_settings": {},
"restrictions": [
{
"min_swap_amount": 123,
"max_swap_amount": 123
}
],
"unavailable_until": 123
},
"info": {
"address": "<string>",
"tvl_usd": 123,
"volume_usd": 123,
"fee_usd": 123,
"apr": 123,
"lp_apr": 123,
"boost_apr": 123,
"locked_asset_amount": "<string>"
}
}
]
}
]{
"error": "<string>"
}Entity
Returns list of pools which correspond to the given params
GET
/
v1
/
pools
Returns list of pools which correspond to the given params
curl --request GET \
--url https://backend.swap.coffee/v1/pools \
--header 'X-Api-Key: <api-key>'import requests
url = "https://backend.swap.coffee/v1/pools"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://backend.swap.coffee/v1/pools', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://backend.swap.coffee/v1/pools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://backend.swap.coffee/v1/pools"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://backend.swap.coffee/v1/pools")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.swap.coffee/v1/pools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"total_count": 123,
"pools": [
{
"pool": {
"dex": "stonfi",
"address": "<string>",
"type": "public",
"amm_type": "constant_product",
"tokens": [
{
"address": {
"blockchain": "ton",
"address": "native"
},
"metadata": {
"name": "ARBUZ",
"symbol": "ARBUZ",
"decimals": 123,
"listed": true,
"verification": "whitelisted",
"image_url": "<string>"
}
}
],
"reserves": [
123
],
"fees": {
"average_gas": 123,
"divider": 123,
"input": 123,
"output": 123,
"first_token": 123,
"second_token": 123
},
"amm_settings": {},
"restrictions": [
{
"min_swap_amount": 123,
"max_swap_amount": 123
}
],
"unavailable_until": 123
},
"info": {
"address": "<string>",
"tvl_usd": 123,
"volume_usd": 123,
"fee_usd": 123,
"apr": 123,
"lp_apr": 123,
"boost_apr": 123,
"locked_asset_amount": "<string>"
}
}
]
}
]{
"error": "<string>"
}Authorizations
Query Parameters
If set, only pools from given blockchains will be returned
Available options:
ton If set, only pools from given DEXes will be returned
Available options:
stonfi, dedust, stonfi_v2, coffee, tonraffles, tonco, colossus, bidask, tonstakers, bemo, bemo_v2, hipo, torch_finance, stakee, kton, evaa, coffin, moon, storm_trade, farmix_lending, dao_lama_vault Returns only those pools which are trusted by DEXes or community
Returns only pools which have active boosts
Returns only pools created within last 24 hours
If set, returns only pools in which liquidity has been partially provisioned by the given address
If set, look for given (sub-)text within pool's address, token tickers and addresses
Available options:
tvl, volume, apr If set, groups pools by DEXes, then handles and returns each group separately
Required range:
1 <= x <= 100Required range:
x >= 1