Authorizations
Headers
The version of the Universal Router to use for the swap journey. MUST be consistent throughout the API calls.
2.0
Body
The handling of the amount
field. EXACT_INPUT
means the requester will send the specified amount
of input tokens and get a quote with a variable quantity of output tokens. EXACT_OUTPUT
means the requester will receive the specified amount
of output tokens and get a quote with a variable quantity of input tokens.
EXACT_INPUT
, EXACT_OUTPUT
The quantity of tokens denominated in the token's base units. (For example, for an ERC20 token one token is 1x10^18 base units. For one USDC token one token is 1x10^6 base units.) This value must be greater than 0.
The wallet address which will be used to send the token.
Indicates whether you want toreceive a permit2 transaction to sign and submit onchain, or a permit message to sign. When set to true
, the quote response returns the Permit2 as a calldata which the user signs and broadcasts. When set to false
(the default), the quote response returns the Permit2 as a message which the user signs but does not need to broadcast. When using a 7702-delegated wallet, set this field to true
. Except for this scenario, it is recommended that this field is set to false. Note that a Permit2 calldata (e.g. true
), will provide indefinite permission for Permit2 to spend a token, in contrast to a Permit2 message (e.g. false
) which is only valid for 30 days. Further, a Permit2 calldata (e.g. true
) requires the user to pay gas to submit the transaction, whereas the Permit2 message (e.g. false
) does not require the user to submit a transaction and requires no gas.
The slippage tollerace as a percentage up to a maximum of two decimal places. For Uniswap Protocols (v2, v3, v4), the slippage tolerance is the maximum amount the price can change between the time the transaction is submitted and the time it is executed. The slippage tolerance is a percentage of the total value of the swap.
When submitting a quote, note that slippage tolerance works differently in UniswapX swaps where it does not set a limit on the Spread in an order. See here for more information.
Note that if the trade type is EXACT_INPUT
, then the slippage is in terms of the output token. If the trade type is EXACT_OUTPUT
, then the slippage is in terms of the input token.
When submitting a request, slippageTolerance
may not be set when autoSlippage
is defined. One of slippageTolerance
or autoSlippage
must be defined.
The auto slippage strategy to employ. Presently there is a single slippage strategy, "DEFAULT", which uses a combination of the estimated gas cost and swap size to calcualte a slippage. Note that the DEFAULT slippage strategy is bounded between (and including) 0.5% and 5.5%.
If the trade type is EXACT_INPUT
, then the slippage is in terms of the output token. If the trade type is EXACT_OUTPUT
, then the slippage is in terms of the input token.
When submitting a request, autoSlippage
may not be set when slippageTolerance
is defined. One of slippageTolerance
or autoSlippage
must be defined.
DEFAULT
The routingPreference
specifies the preferred strategy to determine the quote. If the routingPreference
is BEST_PRICE
, then the quote will propose a route through the specified whitelisted protocols (or all, if none are specified) that provides the best price. When the routingPreference
is FASTEST
, the quote will propose the first route which is found to complete the swap. Note that the values CLASSIC
, BEST_PRICE_V2
, UNISWAPX_V2
, V3_ONLY
, and V2_ONLY
are deprecated and will be removed in a future release. See the Token Trading Workflow page for more information.
BEST_PRICE
, FASTEST
, CLASSIC
, BEST_PRICE_V2
, UNISWAPX_V2
, V3_ONLY
, V2_ONLY
The protocols to use for the swap/order. If the protocols
field is defined, then you can only set the routingPreference
to BEST_PRICE
.
The hook options to use for V4 pool quotes. V4_HOOKS_INCLUSIVE
will get quotes for V4 pools with or without hooks. V4_HOOKS_ONLY
will only get quotes for V4 pools with hooks. V4_NO_HOOKS
will only get quotes for V4 pools without hooks. Defaults to V4_HOOKS_INCLUSIVE
if V4
is included in protocols
and hookOptions
is not set. This field is ignored if V4
is not passed in protocols
.
V4_HOOKS_INCLUSIVE
, V4_HOOKS_ONLY
, V4_NO_HOOKS
For UniswapX swaps, when set to EXECUTION
, quotes optimize for looser spreads at higher fill rates. When set to PRICE
, quotes optimize for tighter spreads at lower fill rates. This field is not applicable to Uniswap Protocols (v2, v3, v4), bridging, or wrapping/unwrapping and will be ignored if set.
EXECUTION
, PRICE
The urgency impacts the estimated gas price of the transaction. The higher the urgency, the higher the gas price, and the faster the transaction is likely to be selected from the mempool. The default value is urgent
.
normal
, fast
, urgent
For Uniswap Protocols (v2, v3, v4) swaps, specify the input token spend allowance (e.g. quantity) to be set in the permit. FULL
can be used to specify an unlimited token quantity, and may prevent the wallet from needing to sign another permit for the same token in the future. EXACT
can be used to specify the exact input token quantity for this request. Defaults to FULL
.
FULL
, EXACT
Response
Quote request successful.
A unique ID for the request.
- Classic Quote
- Wrap/Unwrap Quote
- UniswapX V2 Quote
- UniswapX V3 Quote
- Bridge Quote
- UniswapX Priority Quote
The routing for the proposed transaction.
CLASSIC
, DUTCH_V2
, DUTCH_V3
, BRIDGE
, LIMIT_ORDER
, PRIORITY
, WRAP
, UNWRAP
the permit2 message object for the customer to sign to permit spending by the permit2 contract.
The total estimated gas cost of this transaction (eg. gasLimit
multiplied by maxFeePerGas
) in the base unit of the chain.