GET /swap/v1/price
/swap/v1/price
can be used to acquire an indicative price for a transaction.Rather than returning a transaction that can be submitted to an Ethereum node, this resource simply indicates the pricing that would be available for an analogous call to
/swap/v1/quote
. Identical to the request schema for
/swap/v1/quote
, with a few exceptions on all supported chains:- For
/price
, the default ofskipValidation=true
but can be overridden tofalse
, whereas for/quote
, the default ofskipValidation=false
but can be overridden totrue
- The
intentOnFilling
field will always be undefined.
Query Parameter | Description | Example |
---|---|---|
sellToken | The ERC20 token address or symbol of the token you want to send. Native token such as "ETH" can be provided as a valid sellToken . If the symbol given is not supported, try using token address instead. | sellToken=ETH, sellToken=0x6b175474e89094c44da98b954eedeac495271d0f |
buyToken | The ERC20 token address or symbol of the token you want to receive. Native token such as "ETH" can be provided as a valid buyToken . If the symbol given is not supported, try using token address instead. | buyToken=ETH, buyToken=0x6b175474e89094c44da98b954eedeac495271d0f |
sellAmount | Optional) The amount of sellToken (in sellToken base units) you want to send. | sellAmount=100000000000 |
buyAmount | (Optional) The amount of buyToken (in buyToken base units) you want to receive. | buyAmount=100000000000 |
slippagePercentage | (Optional) The maximum acceptable slippage of the buyToken amount if sellAmount is provided; The maximum acceptable slippage of the sellAmount amount if buyAmount is provided. E.g 0.03 for 3% slippage allowed.
The lowest possible value that can be set for this parameter is 0; in other words, no amount of slippage would be allowed. If no value for this optional parameter is provided in the API request, the default slippage percentage is 1%. | slippagePercentage=0.03 |
gasPrice | (Optional, defaults to ethgasstation "fast") The target gas price (in wei) for the swap transaction. If the price is too low to achieve the quote, an error will be returned. | gasPrice=1000000 |
takerAddress | (Optional) The address which will fill the quote. When provided the gas will be estimated and returned and the entire transaction will be validated for success. If the validation fails a Revert Error will be returned in the response. The quote should be fillable if this address is provided. For example, make sure this address has enough token balance. | takerAddress=0xa8aac589a67ecfade31efde49a062cc21d68a64e |
excludedSources | (Optional) Liquidity sources ( Uniswap , SushiSwap , 0x , Curve etc) that will not be included in the provided quote. See here for a full list of sources | excludedSources=Uniswap_V3,SushiSwap,Curve |
includedSources | (Optional) For now only supports RFQT , which should be used when the integrator only wants RFQ-T liquidity without any other DEX orders. Requires a particular agreement with the 0x integrations team. This parameter cannot be combined with excludedSources . | includedSources=RFQT |
skipValidation | (Optional) If a takerAddress is provided, the API can perform validations for the user. (For more details, see "How does takerAddress help with catching issues?".) When this parameter is set to false , that validation will be run. Note: in the /quote request, validation is the default behavior (see here). In /price requests, validation must be forced by setting skipValidation=false . | skipValidation=false |
feeRecipient | feeRecipient=0xa8aac589a67ecfade31efde49a062cc21d68a64e | |
buyTokenPercentageFee | (Optional) The percentage (between 0 - 1.0) of the buyAmount that should be attributed to feeRecipient as affiliate fees. | buyTokenPercentageFee=0.1 |
affiliateAddress | (Required) An ETH address for which to attribute the trade for tracking and analytics purposes. It can ben any valid ETH address, since it’s just for tagging purposes.
Passing this parameter with your API queries also allows us to provide you data about total volume traded in your application, pairs, MAUs, etc. in a dashboard similar to this.
Additionally, affiliateAddress will allow your project to get metrics on your user's trades via upcoming analytics tools (e.g. 0x Explorer and 0x Data API)
Note affiliateAddress is only for tracking trades and has no impact on affiliate fees, for affiliate fees use feeRecipient . | affiliateAddress=0xa8aac589a67ecfade31efde49a062cc21d68a64e
Here’s an example request (you just need to replace with your chosen affiliateAddress): https://api.0x.org/swap/v1/quote?sellToken=DAI&sellAmount=100000000000000000000&buyToken=WETH&feeRecipient=0x46B5BC959e8A754c0256FFF73bF34A52Ad5CdfA9&buyTokenPercentageFee=0.01&affiliateAddress=0xaae6414A06BbA56D35A80c0Ae96456280EDFd1da |
enableSlippageProtection | (Optional) A boolean field, set to true or false.
If enableSlippageProtection is either not set or set to true, the quote will be adjusted for MEV-aware slippage.
If enableSlippageProtection is false, the quote returned will not be adjusted for MEV-aware slippage (this is recommended for meta-aggregators & integrators who will compare the quoted price with other sources).
See affects on buyAmount , price , and expectedSlippage in the Response fields.
Read more about Slippage Protection. | enableSlippageProtection=true |
Identical to the response schema for
/swap/v1/quote
, with a few exceptions: - the
orders
property will always be undefined guaranteedPrice
,to
anddata
fields will always be undefined
Field | Description |
---|---|
price | If buyAmount was specified in the request it provides the price of buyToken in sellToken and vice versa. This price does not include the slippage provided in the request above, and therefore represents the best possible price.
If enableSlippageProtection in the request was not false, the buyAmount & price responses returned will factor slippage in its routing. |
estimatedPriceImpact | Estimated change in the price of the specified asset that would be caused by the executed swap.
Note : If we fail to estimate price change we will return null |
value | The amount of ether (in wei) that should be sent with the transaction. (Assuming protocolFee is paid in ether). |
gasPrice | The gas price (in wei) that should be used to send the transaction. |
gas | The estimated gas limit that should be used to send the transaction to guarantee settlement. While a computed estimate is returned in all responses, an accurate estimate will only be returned if a takerAddress is included in the request. |
estimatedGas | The estimate for the amount of gas that will actually be used in the transaction. Always less than gas . |
protocolFee | The maximum amount of ether that will be paid towards the protocol fee (in wei), and what is used to compute the value field of the transaction. |
minimumProtocolFee | The minimum amount of ether that will be paid towards the protocol fee (in wei) during the transaction. |
buyTokenAddress | The ERC20 token address of the token you want to receive in quote. |
buyAmount | The amount of buyToken (in buyToken units) that would be bought in this swap. Certain on-chain sources do not allow specifying buyAmount , when using buyAmount these sources are excluded.
If enableSlippageProtection in the request was not false, the buyAmount & price responses returned will factor slippage in its routing. |
sellTokenAddress | The ERC20 token address of the token you want to sell with quote. |
sellAmount | The amount of sellToken (in sellToken units) that would be sold in this swap. Specifying sellAmount is the recommended way to interact with 0xAPI as it covers all on-chain sources. |
sources | The percentage distribution of buyAmount or sellAmount split between each liquidity source. Ex: [{ name: '0x', proportion: "0.8" }, { name: 'Kyber', proportion: "0.2"}, ...] |
allowanceTarget | The target contract address for which the user needs to have an allowance in order to be able to complete the swap. For swaps with "ETH" as sellToken , wrapping "ETH" to "WETH" or unwrapping "WETH" to "ETH" no allowance is needed, a null address of 0x0000000000000000000000000000000000000000 is then returned instead. |
sellTokenToEthRate | The rate between ETH and sellToken |
buyTokenToEthRate | The rate between ETH and buyToken |
expectedSlippage | This is the expected slippage used in routing calculations for the quote returned. It is the value of slippage that we estimate that the selected route will have:
|
Request
GET
https://api.0x.org/swap/v1/price?sellToken=ETH&buyToken=DAI&sellAmount=1000000000000000000
{
"chainId": 1,
"price": "2690.904091272912844972",
"estimatedPriceImpact": "0",
"value": "1000000000000000000",
"gasPrice": "140000000000",
"gas": "151000",
"estimatedGas": "151000",
"protocolFee": "0",
"minimumProtocolFee": "0",
"buyTokenAddress": "0x6b175474e89094c44da98b954eedeac495271d0f",
"buyAmount": "2690904091272912844972",
"sellTokenAddress": "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
"sellAmount": "1000000000000000000",
"sources": [
{
"name": "0x",
"proportion": "0"
},
{
"name": "Uniswap",
"proportion": "0"
},
{
"name": "Uniswap_V2",
"proportion": "0"
},
{
"name": "Eth2Dai",
"proportion": "0"
},
{
"name": "Kyber",
"proportion": "0"
},
{
"name": "Curve",
"proportion": "0"
},
{
"name": "Balancer",
"proportion": "0"
},
{
"name": "Balancer_V2",
"proportion": "0"
},
{
"name": "Bancor",
"proportion": "0"
},
{
"name": "mStable",
"proportion": "0"
},
{
"name": "Mooniswap",
"proportion": "0"
},
{
"name": "Swerve",
"proportion": "0"
},
{
"name": "SnowSwap",
"proportion": "0"
},
{
"name": "SushiSwap",
"proportion": "0"
},
{
"name": "Shell",
"proportion": "0"
},
{
"name": "MultiHop",
"proportion": "0"
},
{
"name": "DODO",
"proportion": "0"
},
{
"name": "DODO_V2",
"proportion": "0"
},
{
"name": "CREAM",
"proportion": "0"
},
{
"name": "LiquidityProvider",
"proportion": "0"
},
{
"name": "CryptoCom",
"proportion": "0"
},
{
"name": "Linkswap",
"proportion": "0"
},
{
"name": "Lido",
"proportion": "0"
},
{
"name": "MakerPsm",
"proportion": "0"
},
{
"name": "KyberDMM",
"proportion": "0"
},
{
"name": "Smoothy",
"proportion": "0"
},
{
"name": "Component",
"proportion": "0"
},
{
"name": "Saddle",
"proportion": "0"
},
{
"name": "xSigma",
"proportion": "0"
},
{
"name": "Uniswap_V3",
"proportion": "1"
},
{
"name": "Curve_V2",
"proportion": "0"
},
{
"name": "ShibaSwap",
"proportion": "0"
},
{
"name": "Synapse",
"proportion": "0"
}
],
"allowanceTarget": "0x0000000000000000000000000000000000000000",
"sellTokenToEthRate": "1",
"buyTokenToEthRate": "2684.34399396039791937"
}
Last modified 16d ago