/quote - Request a trade quote
Endpoint
Method: POST
URL: https://api.swapkit.dev/quote
Request parameters
Here's a detailed description of the different parameters:
sellAsset
string
✅ Yes
The asset being sold (e.g. "ETH.ETH").
buyAsset
string
✅ Yes
The asset being bought (e.g. "BTC.BTC").
sellAmount
string
✅ Yes
Amount in basic units (decimals separated with a dot).
providers
array
❌ No
Limits the possible liquidity providers.
sourceAddress
string
✅ Yes
Address of the sender.
destinationAddress
string
✅ Yes
Address of the recipient.
slippage
number
❌ No
Max slippage in percentage (5 = 5%).
affiliate
string
❌ No
Affiliate address for revenue sharing.
affiliateFee
number
❌ No
Fee percentage in basis points (50= 0.5%).
allowSmartContractSender
boolean
❌ No
Allow smart contract as sender.
allowSmartContractReceiver
boolean
❌ No
Allow smart contract as receiver.
disableSecurityChecks
boolean
❌ No
Bypass security checks.
includeTx
boolean
❌ No
Include transaction details in the response.
cfBoost
boolean
❌ No
Enables Chainflip boost for better rates.
Note: Asset names for sellAsset and buyAsset should follow the following nomenclature:
Chain.Ticker (e.g.,
"BTC.BTC"or"ARB.ETH")Chain.Ticker-ContractAddress (e.g.,
"ETH.USDC-0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48")
This is the identifieras provided in the /tokens endpoint.
Example request
A simple request to trade ETH.ETHto BTC.BTCmay omit the providerslist if you can manage them in the response, but should include the amount, the involved addresses and slippage settings.
The expiration time returned by the endpoint is an estimation. We recommend requesting a new quote at least every minute if the trade has not been executed yet.
Using the header x-api-keyin your /quoterequest automatically applies your affiliate addresses and fee values set up through our partners dashboard in the response parameters.
Last updated