- Documentation
- GitHub
- Developer Chat
- Developer Channel
- Token Listing
- Get API Key
- Aggregator API
- TokensDB API
Entity
- GETGet supported blockchains. Currently only TON is supported.
- GETReturns list of supported decentralized exchanges supported by the service in the given blockchain
- GETReturns information about the given decentralized exchange for the given blockchain
- GETReturns list of liquid staking pools
- GETReturns staking pool for given address
- GETReturns list of pools which correspond to the given params
- DELClear pools metadata cache. For internal usage only
- GETReturns trading metrics for pools
- GETReturns information about the given liquidity pool for the given blockchain
- POSTUpdates pool's data. For internal usage only
- GETReturns list of pools associated with given token
- GETReturns list of tokens supported by the service
- GETReturns list of tokens supported by the service
- GETReturns information about the given token for the given blockchain
- GETReturns information about the given token by its symbol for the given blockchain
- POSTReturns prices for given tokens
Routing
- POSTReturns the best route for the given trade pair
- POSTReturns the best route for the given list of input tokens and output token
- POSTReturns the best route for the given trade pair using smart settings
- POSTReturns pre-built transactions for the given route. It is assumed that transactions will be signed and sent by the sender via wallet
- POSTReturns pre-built transaction for the given unstake request. It is assumed that transaction will be signed and sent by the sender via wallet
- POSTReturns pre-built transaction for the given stake request. It is assumed that transaction will be signed and sent by the sender via wallet
- GETGet route transactions execution resultdeprecated
- GETGet route transactions execution result
Profile
Auth
Referral
Claim
Cashback
Contests
Strategies
- GETCheck whether strategies wallet exists for given account address.
- POSTGet pre-built transaction for strategies wallet creation.
- GETChecks whether user is eligible for using strategies
- GETGet list of supported from-tokens for strategies
- GETGet list of supported to-tokens for strategies for given from-token
- GETGet strategy orders
- GETGet strategy order
- POSTGet pre-built transaction for strategy order creation
- DELGet pre-built transaction for strategy order cancellation
- DELCancel strategy order by id. For internal usage only.
- DELCancel all strategy orders by proxy wallet. For internal usage only.
- DELCancel all strategy orders by given token pair. For internal usage only.
- DELCancel all strategy orders. For internal usage only.
- POSTMake a payout from strategy wallet to wallet's owner. For internal usage only.
Partnership
- GETGet raw transaction records with specified partner's referral address. Requires associated x-api-key.
- GETGet partner settings. For internal usage only
- POSTSet partner settings. For internal usage only
- DELDelete partner settings. For internal usage only
- GETGet token claiming global stats. Requires associated x-api-key.
- GETGet token claiming user stats. Requires associated x-api-key.
- POSTAccrue token to claim center. Requires associated x-api-key.
- POSTRegister new partner token for claiming center. For internal usage only.
- PATCHIncrease total amount of existing partner token within claiming center. For internal usage only.
- GETGet aggregated information about staking for specific user. Requires associated x-api-key.
Staking
- GETGet all stakings
- GETGet staking transaction execution result
- GETGet aggregated information about staking
- GETGet aggregated information about staking for specific user
- GETGet user's staking points
- GETGet user's balances of staked tokens
- POSTBuild transaction to create new staking position
- POSTBuild transaction to extend existing position
- DELBuild transaction to close position and withdraw all money
DEX
LiquidityProvisioning
- GETReturn information about user's LP position in pool
- POSTBuild transactions to provide liquidity to the given pool
- DELBuild transaction to withdraw liquidity from the given pool
- GETReturns pools on Coffee DEX that correspond to the pools of provided addresses
- GETReturns list of pools from which user may migrate tokens
- POSTBuild transaction to migrate LP to swap.coffee DEX
- GETReturns list of pools that are possible for migration of LP.
- GETReturns pool total supply
- GETReturns status of liquidity provisioning operation
Boosts
- GETReturns pool's aggregated APR
- GETReturns list of boosts for the pool
- GETReturns user's earned boosts in given pool
- POSTBuild transaction to create boost for pool in swap.coffee DEX
- GETGet detailed info about boost. Works for Coffee DEX pools only
- POSTBuild transaction to create stonfi farm position
- DELBuild transaction to close farm position in stonfi
- GETReturns status of new boost creation operation. Works for Coffee DEX pools only
Returns pool's aggregated APR
curl --request GET \
--url https://backend.swap.coffee/v1/boost/{pool_address}/apr \
--header 'X-Api-Key: <api-key>'{
"apr": 123
}Boosts
Returns pool's aggregated APR
GET
/
v1
/
boost
/
{pool_address}
/
apr
Returns pool's aggregated APR
curl --request GET \
--url https://backend.swap.coffee/v1/boost/{pool_address}/apr \
--header 'X-Api-Key: <api-key>'{
"apr": 123
}Documentation Index
Fetch the complete documentation index at: https://docs.swap.coffee/llms.txt
Use this file to discover all available pages before exploring further.
⌘I