Entity
Returns list of pools which correspond to the given params
Changed onget/v1/pools
Request
- Base URLhttps://backend.swap.coffee
- Auth
- none
- or API key in header X-Api-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
blockchainsApi Supported Blockchain[]
If set, only pools from given blockchains will be returned
dexesApi Supported Yields[]
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
Example response
[
{
"pools": [
{
"pool": {
"dex": "stonfi",
"tokens": [
{
"address": {
"blockchain": "ton",
"address": "native"
},
"metadata": {
"name": "ARBUZ",
"symbol": "ARBUZ"
}
}
]
}
}
]
}
]Changes
- info
added the enum value
dedust_v2to the propertyitems/of thequeryrequest parameterdexes
- info
- info
added the enum value
tonco_v2to the propertyitems/of thequeryrequest parameterdexes
- info