Swapping Endpoints

Quote

Requests a quote according to the specified swap parameters. This endpoint may be used to get a quote for a swap, a bridge, or a wrap/unwrap. The resulting response includes a quote for the swap and the proposed route by which the quote was achieved. The response will also include estimated gas fees for the proposed quote route. If the proposed route is via a Uniswap Protocol pool, the response may include a permit2 message for the swapper to sign prior to making a /swap request. The proposed route will also be simulated. If the simulation fails, the response will include an error message or txFailureReason.

Certain routing options may be whitelisted by the requestor through the use of the protocols field. Further, the requestor may ask for the best price route or for the fastest price route through the ‘routingPreference’ field. Note that the fastest price route refers to the speed with which a quote is returned, not the number of transactions that may be required to get from the input token and chain to the output token and chain. Further note that all routingPreference values except for FASTEST and BEST_PRICE are deprecated. For more information on the protocols and routingPreference fields, see the Token Trading Workflow explanation of Swap Routing.

API integrators using this API for the benefit of customer end users may request a service fee be taken from the output token and deposited to a fee collection address. To request this, please reach out to your Uniswap Labs contact. This optional fee is associated to the API key and is always taken from the output token. Note if there is a fee and the type is EXACT_INPUT, the output amount quoted will not include the fee subtraction. If there is a fee and the type is EXACT_OUTPUT, the input amount quoted will not include the fee addition. Instead, in both cases, the fee will be recorded in the portionBips and portionAmount fields.

POST

quote

curl --request POST \
  --url https://trade-api.gateway.uniswap.org/v1/quote \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "type": "EXACT_INPUT",
  "amount": "<string>",
  "tokenInChainId": 1,
  "tokenOutChainId": 1,
  "tokenIn": "<string>",
  "tokenOut": "<string>",
  "generatePermitAsTransaction": false,
  "swapper": "<string>",
  "slippageTolerance": 123,
  "autoSlippage": "undefined",
  "routingPreference": "BEST_PRICE",
  "protocols": [
    "V2"
  ],
  "hooksOptions": "V4_HOOKS_INCLUSIVE",
  "spreadOptimization": "EXECUTION",
  "urgency": "urgent",
  "permitAmount": "FULL"
}'

{
  "requestId": "<string>",
  "quote": {
    "input": {
      "token": "<string>",
      "amount": "<string>"
    },
    "output": {
      "token": "<string>",
      "amount": "<string>",
      "recipient": "<string>"
    },
    "swapper": "<string>",
    "chainId": 1,
    "slippage": 123,
    "tradeType": "EXACT_INPUT",
    "gasFee": "<string>",
    "gasFeeUSD": "<string>",
    "gasFeeQuote": "<string>",
    "route": [
      [
        {
          "type": "v3-pool",
          "address": "<string>",
          "tokenIn": {
            "address": "<string>",
            "chainId": 1,
            "symbol": "ETH",
            "decimals": "<string>",
            "buyFeeBps": "<string>",
            "sellFeeBps": "<string>"
          },
          "tokenOut": {
            "address": "<string>",
            "chainId": 1,
            "symbol": "ETH",
            "decimals": "<string>",
            "buyFeeBps": "<string>",
            "sellFeeBps": "<string>"
          },
          "sqrtRatioX96": "<string>",
          "liquidity": "<string>",
          "tickCurrent": "<string>",
          "fee": "<string>",
          "amountIn": "<string>",
          "amountOut": "<string>"
        }
      ]
    ],
    "portionBips": 123,
    "portionAmount": "<string>",
    "portionRecipient": "<string>",
    "routeString": "<string>",
    "quoteId": "<string>",
    "gasUseEstimate": "<string>",
    "blockNumber": "<string>",
    "gasPrice": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>",
    "txFailureReasons": [
      "SIMULATION_ERROR"
    ],
    "priceImpact": 123,
    "aggregatedOutputs": [
      {
        "token": "<string>",
        "amount": "<string>",
        "recipient": "<string>",
        "bps": 123,
        "minAmount": "<string>"
      }
    ]
  },
  "routing": "DUTCH_LIMIT",
  "permitTransaction": {
    "to": "<string>",
    "from": "<string>",
    "data": "<string>",
    "value": "<string>",
    "gasLimit": "<string>",
    "chainId": 1,
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>",
    "gasPrice": "<string>"
  },
  "permitData": {
    "domain": {},
    "values": {},
    "types": {}
  },
  "permitGasFee": "<string>"
}

Authorizations

x-api-key

string

header

required

Headers

x-universal-router-version

enum<string>

default:1.2

The version of the Universal Router to use for the swap journey. MUST be consistent throughout the API calls.

Available options:

1.2,

2.0

Body

application/json

Response

200

application/json

Quote request successful.

The response is of type object.

Limit QuoteGet a quote for a limit order according to the provided configuration.

curl --request POST \
  --url https://trade-api.gateway.uniswap.org/v1/quote \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "type": "EXACT_INPUT",
  "amount": "<string>",
  "tokenInChainId": 1,
  "tokenOutChainId": 1,
  "tokenIn": "<string>",
  "tokenOut": "<string>",
  "generatePermitAsTransaction": false,
  "swapper": "<string>",
  "slippageTolerance": 123,
  "autoSlippage": "undefined",
  "routingPreference": "BEST_PRICE",
  "protocols": [
    "V2"
  ],
  "hooksOptions": "V4_HOOKS_INCLUSIVE",
  "spreadOptimization": "EXECUTION",
  "urgency": "urgent",
  "permitAmount": "FULL"
}'

{
  "requestId": "<string>",
  "quote": {
    "input": {
      "token": "<string>",
      "amount": "<string>"
    },
    "output": {
      "token": "<string>",
      "amount": "<string>",
      "recipient": "<string>"
    },
    "swapper": "<string>",
    "chainId": 1,
    "slippage": 123,
    "tradeType": "EXACT_INPUT",
    "gasFee": "<string>",
    "gasFeeUSD": "<string>",
    "gasFeeQuote": "<string>",
    "route": [
      [
        {
          "type": "v3-pool",
          "address": "<string>",
          "tokenIn": {
            "address": "<string>",
            "chainId": 1,
            "symbol": "ETH",
            "decimals": "<string>",
            "buyFeeBps": "<string>",
            "sellFeeBps": "<string>"
          },
          "tokenOut": {
            "address": "<string>",
            "chainId": 1,
            "symbol": "ETH",
            "decimals": "<string>",
            "buyFeeBps": "<string>",
            "sellFeeBps": "<string>"
          },
          "sqrtRatioX96": "<string>",
          "liquidity": "<string>",
          "tickCurrent": "<string>",
          "fee": "<string>",
          "amountIn": "<string>",
          "amountOut": "<string>"
        }
      ]
    ],
    "portionBips": 123,
    "portionAmount": "<string>",
    "portionRecipient": "<string>",
    "routeString": "<string>",
    "quoteId": "<string>",
    "gasUseEstimate": "<string>",
    "blockNumber": "<string>",
    "gasPrice": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>",
    "txFailureReasons": [
      "SIMULATION_ERROR"
    ],
    "priceImpact": 123,
    "aggregatedOutputs": [
      {
        "token": "<string>",
        "amount": "<string>",
        "recipient": "<string>",
        "bps": 123,
        "minAmount": "<string>"
      }
    ]
  },
  "routing": "DUTCH_LIMIT",
  "permitTransaction": {
    "to": "<string>",
    "from": "<string>",
    "data": "<string>",
    "value": "<string>",
    "gasLimit": "<string>",
    "chainId": 1,
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>",
    "gasPrice": "<string>"
  },
  "permitData": {
    "domain": {},
    "values": {},
    "types": {}
  },
  "permitGasFee": "<string>"
}

Swapping Endpoints

Liquidity Provisioning Endpoints

Reference Data Endpoints

Utility Endpoints

Quote

Authorizations

Headers

Body

Response